Archive a stream
This endpoint is only available to organization administrators.
Archive the stream with the ID
# The user for this zuliprc file must be an organization administrator
client = zulip.Client(config_file="~/zuliprc-admin")
# Archive the stream named 'stream to be archived'
stream_id = client.get_stream_id("stream to be archived")["stream_id"]
result = client.delete_stream(stream_id)
curl -sSX DELETE https://juxt-oss.zulipchat.com/api/v1/streams/1 \
stream_id integer required in path
The ID of the stream to access.
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
A typical successful JSON response may look like:
An example JSON response for when the supplied stream does not exist:
"msg": "Invalid stream ID",