PATCH /streams/{stream_id}

The ID of the channel to access.

Default value: "application/x-www-form-urlencoded"

ID of the new channel folder to which the channel should belong.

A null value indicates the user wants to remove the channel from its current channel folder.

Changes: New in Zulip 11.0 (feature level 389).

Change whether the channel is a web-public channel.

Note that creating web-public channels requires the WEB_PUBLIC_STREAMS_ENABLED server setting to be enabled on the Zulip server in question, the organization to have enabled the enable_spectator_access realm setting, and the current use to have permission under the organization's can_create_web_public_channel_group realm setting.

Changes: New in Zulip 5.0 (feature level 98).

The new description for the channel, in Zulip-flavored Markdown format.

Clients should use the max_stream_description_length returned by the POST /register endpoint to determine the maximum channel description length.

Changes: Removed unnecessary JSON-encoding of this parameter in Zulip 4.0 (feature level 64).

Add or remove the channel as a default channel for new users joining the organization.

Changes: New in Zulip 8.0 (feature level 200). Previously, default channel status could only be changed using the dedicated API endpoint.

Number of days that messages sent to this channel 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.
• "unlimited": Retain messages forever.

Changes: Prior to Zulip 5.0 (feature level 91), retaining messages forever was encoded using "forever" instead of "unlimited".

New in Zulip 3.0 (feature level 17).

The new name for the channel.

Clients should use the max_stream_name_length returned by the POST /register endpoint to determine the maximum channel name length.

Changes: Removed unnecessary JSON-encoding of this parameter in Zulip 4.0 (feature level 64).

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

Corresponds to the shared history option for private channels.

It's an error for this parameter to be false for a public or web-public channel and when is_private is false.

This can only be false if can_create_topic_group for the channel is the role:everyone system group.

Changes: Before Zulip 6.0 (feature level 136), history_public_to_subscribers was silently ignored unless the request also contained either is_private or is_web_public.

Whether named topics and the empty topic (i.e., "general chat" topic) are enabled in this channel.

• "inherit": Messages can be sent to named topics in this channel, and the organization-level realm_topics_policy is used for whether messages can be sent to the empty topic in this channel.
• "allow_empty_topic": Messages can be sent to both named topics and the empty topic in this channel.
• "disable_empty_topic": Messages can be sent to named topics in this channel, but the empty topic is disabled.
• "empty_topic_only": Messages can be sent to the empty topic in this channel, but named topics are disabled. See "general chat" channels.

The "empty_topic_only" policy can only be set if all existing messages in the channel are already in the empty topic.

When creating a new channel, if the topics_policy is not specified, the "inherit" option will be set.

Changes: In Zulip 11.0 (feature level 404), the "empty_topic_only" option was added.

New in Zulip 11.0 (feature level 392).

Valid values:

• "empty_topic_only"
• "inherit"
• "allow_empty_topic"
• "disable_empty_topic"

Change whether the channel is a private channel.

A boolean indicating whether the channel is archived or unarchived. Currently only allows unarchiving previously archived channels.

Changes: New in Zulip 11.0 (feature level 388).