Home

Integrations

Interactive bots (beta)

REST API

Messages

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Update a stream

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

PATCH https://zulip.dioco.io/api/v1/streams/{stream_id}

Usage examples

  • Python
  • curl

#!/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://zulip.dioco.io/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'

Parameters

stream_id required in path

Example: 42

The ID of the stream to access.

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.

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 3.0, replacing the previous is_announcement_only boolean.

Defaults to 1.

history_public_to_subscribers optional

Example: False

Whether the stream's message history should be available to newly subscribed members, or users can only access messages they actually received while subscribed to the stream.

Corresponds to the shared history option in documentation.

message_retention_days optional

Example: 20

Number of days that messages sent to this stream will be stored before being automatically deleted by the message retention policy. Two special string format values are supported:

  • "realm_default" => Return to the organization-level setting.
  • "forever" => Retain messages forever.

Changes: New in Zulip 3.0 (feature level 17).

is_announcement_only optional Deprecated

Example: True

Whether the stream is limited to announcements.

Changes: Deprecated in Zulip 3.0 (feature level 1), use stream_post_policy instead.

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