Update a channel folder
This endpoint is only available to organization administrators.
PATCH https://lexicogenesis.zulipchat.com/api/v1/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).
Usage examples
curl -sSX PATCH https://lexicogenesis.zulipchat.com/api/v1/channel_folders/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode name=backend \
--data-urlencode 'description=Backend channels.' \
--data-urlencode is_archived=true
Parameters
channel_folder_id integer required in path
Example: 1
The ID of the target channel folder.
name string optional
Example: "backend"
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 optional
Example: "Backend channels."
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 optional
Example: true
Whether to archive or unarchive the channel folder.
Response
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}
An example JSON response when the channel folder ID is invalid:
{
"code": "BAD_REQUEST",
"msg": "Invalid channel folder ID",
"result": "error"
}