Ban a member from a group channel
Bans a member from a group channel. A banned member is immediately expelled from a channel and is allowed to join the channel again only after a set period of time has passed.
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 |
---|---|---|
channel_url | string | Specifies the URL of a channel. |
Request body
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of a user. |
Optional | Type | Description |
---|---|---|
agent_id | string | Specifies the ID of an operator who bans a user. |
seconds | int | Specifies the duration of ban in seconds. If set to -1, a user will be banned for ten years, which refers to a permanent ban on the Sendbird Dashboard. (Default: -1) |
description | string | Specifies the reason for ban. The maximum length is 250 characters. |
Response
If successful, this action returns the banned user resource and ban information in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
user | object | The user resource that contains brief information about the banned user. |
start_at | long | The time when the user becomes banned in the channel. The value is in Unix milliseconds format. |
end_at | long | The timestamp of when the ban is scheduled to end. The value is in Unix milliseconds format. |
description | string | The reason for ban. |
In the case of an error, an error object is returned. A detailed list of error codes is available here.