Create a channel folder

POST https://chat.zulip.org/api/v1/channel_folders/create

Create a new channel folder, that will be used to organize channels in left sidebar.

Only organization administrators can create a new channel folder.

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

Usage examples

curl -sSX POST https://chat.zulip.org/api/v1/channel_folders/create \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode name=marketing \
    --data-urlencode 'description=Channels for marketing.'

Parameters

Response

Return values

• channel_folder_id: integer

  The unique ID of the created channel folder.

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:

{
    "channel_folder_id": 123,
    "msg": "",
    "result": "success"
}

Error when the user does not have permission to create a channel folder:

{
    "code": "UNAUTHORIZED_PRINCIPAL",
    "msg": "Must be an organization administrator",
    "result": "error"
}