Get channel's email address


Get email address of a channel.

Changes: New in Zulip 8.0 (feature level 226).

Usage examples

curl -sSX GET -G \


stream_id integer required in path

Example: 1

The ID of the channel to access.


Return values

  • email: string

    Email address of the channel.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

    "email": "",
    "msg": "",
    "result": "success"

An example JSON response for when the requested channel does not exist, or where the user does not have permission to access the target channel:

    "code": "BAD_REQUEST",
    "msg": "Invalid channel ID",
    "result": "error"