Creates an open channel. See this page to learn more about channel types.
Note: Sendbird applications created after December 15, 2020, will only be able to create dynamic partitioned open channels. Classic open channels in applications created prior to this date remain fully functional.
The following table lists the properties of an HTTP request that this action supports.
Optional
Property name | Type | Description |
---|---|---|
name | string | Specifies the channel topic, or the name of the channel. The length is limited to 191 characters. (Default: open channel) |
channel_url | string | Specifies the URL of the channel. Only numbers, characters, and underscores are allowed. The allowed length is 4 to 100 characters, inclusive. If not specified, a URL is automatically generated. |
cover_url | string | Specifies the URL of the channel's cover image. The length is limited to 2,048 characters. |
cover_file | file | Uploads a file for the channel's cover image. |
custom_type | string | Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters. |
data | string | Specifies additional channel information such as a long description of the channel or |
is_ephemeral | boolean | Determines whether to preserve messages in the channel for the purpose of later retrieving chat history. If set to true, messages in the channel are not saved in the Sendbird database and chat history can't be retrieved. (Default: false) |
boolean | Determines whether the channel to be created is an open channel based on a dynamic partitioning structure. The value of true indicates that the open channel can create several subchannels in order to accommodate a massive number of users. (Default: false) | |
operator_ids[] | array of strings | Specifies an array of one or more user IDs to register as operators of the channel. The maximum number of operators allowed per channel is 100. Operators can delete any messages in the channel, and even receive all messages that have been throttled. |
| array of strings | (Deprecated) Specifies the string IDs of the users registered as channel operators. Operators can delete any messages in the channel and even receive all messages that have been throttled. |
Note: If you want to upload a profile picture by passing an image
file
instead of a URL, see Multipart requests.
If successful, this action returns an open channel resource in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.