GET /streams/{stream_id}/email_address

Get email address of a channel.

Note that only users with permission to post messages in the channel can access the channel's email address.

Changes: Prior to Zulip 12.0 (feature level 448), users without permission to post messages in the channel could access the channel's email if they had metadata access.

New in Zulip 8.0 (feature level 226).

Servers

Path parameters

Name Type Required Description
stream_id Integer Yes

The ID of the channel to access.

Query parameters

Name Type Required Description
sender_id Integer No

The ID of a user or bot which should appear as the sender when messages are sent to the channel using the returned channel email address.

sender_id can be:

  • ID of the current user.
  • ID of the Email gateway bot. (Default value)
  • ID of a bot owned by the current user.

Changes: New in Zulip 10.0 (feature level 335).

Previously, the sender was always Email gateway bot.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.