Create a channel folder
This endpoint is only available to organization administrators.
POST https://cs510sound-spring2021.zulip.cs.pdx.edu/api/v1/channel_folders/create
Create a new channel folder.
Changes: New in Zulip 11.0 (feature level 389).
Usage examples
curl -sSX POST https://cs510sound-spring2021.zulip.cs.pdx.edu/api/v1/channel_folders/create \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode name=marketing \
--data-urlencode 'description=Channels for marketing.'
Parameters
name string required
Example: "marketing"
The 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: "Channels for marketing."
The 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.
Note that this parameter must be passed as part of the request,
but can be an empty string if no description for the new channel
folder is desired.
Response
Return values
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": 12,
"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"
}