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.
HTTP Request
Parameters
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
custom_type | string | Specifies a custom channel type. |
Request body
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
user_ids[] | array of strings | Specifies an array of one or more user IDs. |
Optional | Type | Description |
---|---|---|
seconds | long | 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) |
description | string | Specifies the reason for mute. The maximum length is 2,048 characters. |
on_demand_upsert | boolean | Determines whether the Sendbird system should create new users to mute if there are no users with the IDs specified in the |
Response
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.