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://yourZulipDomain.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,
    'stream_post_policy': 2,
    'is_private': True,
}

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

curl -sSX PATCH https://yourZulipDomain.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

stream_id required

Example: 42

The ID of the stream to be updated.


description optional

Example: "This stream is related to football dicsussions."

The new description for the stream.


new_name optional

Example: "Italy"

The new name for the stream.


is_private optional

Example: true

Change whether the stream is a private stream.


is_announcement_only optional

Example: true

Whether the stream is limited to announcements.

Changes: Deprecated in Zulip 2.2, use stream_post_policy instead.


stream_post_policy optional

Example: 2

Policy for which users can post messages to the stream.

  • 1 => Any user can post.
  • 2 => Only administrators can post.
  • 3 => Only new members can post.

Changes: New in Zulip 2.2, replacing the previous is_announcement_only boolean.


history_public_to_subscribers optional

Example: true

Whether subscribers have access to full stream history, even before they joined the stream.


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