Delete stream

Delete the stream with the ID stream_id.

DELETE https://openpl.zulipchat.com/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://openpl.zulipchat.com/api/v1/streams/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Arguments

Note: The following arguments are all URL query parameters.

Argument Example Required Description
stream_id 42 Yes

The ID of the stream to be deleted.

Response

Return values

  • stream_id: The ID of a stream.

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"
}