Mutes a member in a group channel. A muted member remains in the channel and is allowed to view the messages, but can't send messages until unmuted.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
channel_url | string | Specifies the URL of a channel. |
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
user_id | string | Specifies the ID of a user. |
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. |
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.