Updates information about an open channel.
Note: See this page to learn more about channel types.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
channel_url | string | Specifies the URL of the channel. |
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. |
cover_url | string | Specifies the URL of the cover image. The length is limited to 2,048 characters. |
cover_file | file | Uploads the file for the channel 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 |
operator_ids[] | array of strings | Specifies an array of one or more user IDs to register as operators of the channel. A single channel can have up to 100 channel operators. 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 operators of the channel. Operators can delete any messages in the channel and also 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 updated 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.