PATCH /channel_folders/{channel_folder_id}

Update the name or description of a channel folder with the specified ID.

This endpoint is also used to archive or unarchive the specified channel folder.

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

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Path parameters

Name	Type	Required	Description
`channel_folder_id`	Integer	Yes	The ID of the target channel folder.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`name`	String	No	The new name of the channel folder. Clients should use the `max_channel_folder_name_length` returned by the `POST /register` endpoint to determine the maximum channel folder name length. Value cannot be an empty string.
`description`	String	No	The new description of the channel folder. Clients should use the `max_channel_folder_description_length` returned by the `POST /register` endpoint to determine the maximum channel folder description length.
`is_archived`	Boolean	No	Whether to archive or unarchive the channel folder.

name

String

The new name of the channel folder.

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

Value cannot be an empty string.

description

String

The new description of the channel folder.

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

is_archived

Boolean

Whether to archive or unarchive the channel folder.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.