Delete a stream
Delete the stream with the ID stream_id.
DELETE https://zulip.dioco.io/api/v1/streams/{stream_id}
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Delete the stream named 'new stream'
stream_id = client.get_stream_id('stream to be deleted')['stream_id']
result = client.delete_stream(stream_id)
print(result)
curl -sSX DELETE https://zulip.dioco.io/api/v1/streams/42 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
Note: The following parameters are all URL query parameters.
stream_id required in path
Example: 42
The ID of the stream to access.
Response
Example response
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}
An example JSON response for when the supplied stream does not exist:
{
"code": "BAD_REQUEST",
"msg": "Invalid stream id",
"result": "error"
}