Update a channel folder

PATCH https://chat.zulip.org/api/v1/channel_folders/{channel_folder_id}

Update the name or description of a channel folder.

This endpoint is also used to archive and unarchive a channel folder.

Only organization administrators can update a channel folder.

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

Usage examples

curl -sSX PATCH https://chat.zulip.org/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

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