Update stream

Configure the stream with the ID stream_id. This endpoint supports an organization administrator editing any property of a stream, including:

PATCH 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")

# Update the stream by a given ID
request = {
    'stream_id': stream_id,
    'is_announcement_only': True,
    'is_private': True,
}

result = client.update_stream(request)
print(result)

curl -sSX PATCH https://openpl.zulipchat.com/api/v1/streams/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'description="This stream is related to football dicsussions."' \
    -d 'new_name="Italy"' \
    -d 'is_private=true'

Arguments

Argument Example Required Description
stream_id 42 Yes

The ID of the stream to be updated.

description "This stream is related to football dicsussions." No

The new description for the stream.

new_name "Italy" No

The new name for the stream.

is_private true No

The new state of the stream.

is_announcement_only true No

The new state for the announcements.

history_public_to_subscribers true No

The new state for the history_public_to_subscribers.

Response

Return values

  • stream_id: The ID of the stream to be updated.

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