zulip/templates/zerver/api/update-stream.md

Update stream

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

• Stream name and description
• Stream permissions, including privacy and who can send.

PATCH {{ api_url }}/v1/streams/{stream_id}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/streams/{stream_id}:patch|example}

{tab|curl}

{generate_code_example(curl, include=["new_name", "description", "is_private"])|/streams/{stream_id}:patch|example}

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:patch}

Response

Return values

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

Example response

A typical successful JSON response may look like:

{generate_code_example|/streams/{stream_id}:patch|fixture(200)}

An example JSON response for when the supplied stream does not exist:

{generate_code_example|/streams/{stream_id}:patch|fixture(400)}