Updates information about a group channel or a Supergroup channel. You can't make any changes to the members of a channel with this API. To change members, see invite as members instead.
Note: See this page to learn more about channel types.
The following table lists the parameters that this action supports.
Specifies the URL of the channel.
The following table lists the properties of an HTTP request that this action supports.
Note: If you convert a group channel to a Supergroup channel by changing a value of
is_superto true, you won't be able to change it back to a group channel.
Specifies the name of the channel or the channel topic. The length is limited to 191 characters.
Specifies the unique URL of the channel's cover image. The length is limited to 2,048 characters.
Uploads the file for the channel cover image.
Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters.
Specifies additional channel information such as a long description of the channel or
Determines whether to reuse an existing channel or create a new channel when creating a channel with the same group of members. If set to true, returns an existing channel with the same members or creates a new channel if no such channel exists. Sendbird server can also use the custom channel type in the
Determines whether to allow a user to join the channel without an invitation. (Default: false)
Determines whether to allow the channel to accommodate 100 or more members. If set to true, creates a Supergroup channel. (Default: false)
This parameter can only be used when the channel operator creates a public group channel. If the channel operator uses an access code for the corresponding type of channel, users will be required to enter the access code to join the channel. If specified, the
array of strings
Specifies an array of one or more IDs of users to register as operators of the channel. Users can be registered as operators regardless of whether they are channel members. The maximum allowed number of operators per channel is 100.
Note: If you want to upload a profile picture by passing an image
fileinstead of a URL, see Multipart requests.
If successful, this action returns an updated group 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.