Ban a user from channels by custom channel types
Bans a user from channels with the specified custom channel types.
Note: To learn more about other available moderation tools, see Moderation Overview.
HTTP request
Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with
https://api-{application_id}.svc.delight.ai/v3instead ofhttps://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.
Parameters
The following table lists the parameters that this action supports.
Required
| Parameter name | Type | Description |
|---|---|---|
user_id | string | Specifies the unique ID of a user. |
Request body
The following table lists the properties of an HTTP request that this action supports.
Required
| Property name | Type | Description |
|---|---|---|
channel_custom_types[] | array of strings | Specifies an array of one or more custom channel types to ban a user from. |
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.