Mute users in channels by a custom channel type
Mutes specified users in channels with a custom channel type at once.
Note: To learn more about other available moderation tools, see Moderation Overview.
The following table lists the parameters that this action supports.
Specifies a custom channel type.
The following table lists the properties of an HTTP request that this action supports.
array of strings
Specifies an array of one or more user IDs.
Specifies the duration of mute in seconds. If set to -1, the user will be muted for ten years, which refers to a permanent mute in the Sendbird Dashboard. (Default: -1)
Specifies the reason for mute. The maximum length is 2,048 characters.
Determines whether the Sendbird system should create new users to mute if there are no users with the IDs specified in the
If successful, this action returns an empty response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.