Get the email address of a stream

GET https://backdrop.zulipchat.com/api/v1/streams/{stream_id}/email_address

Get email address of a stream.

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

Usage examples

curl -sSX GET -G https://backdrop.zulipchat.com/api/v1/streams/1/email_address \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Return values

• email: string

  Email address of the stream.

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": "test_stream.af64447e9e39374841063747ade8e6b0.show-sender@testserver",
    "msg": "",
    "result": "success"
}

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

{
    "code": "BAD_REQUEST",
    "msg": "Invalid stream ID",
    "result": "error"
}