Chat Platform API v3
Chat Platform API
Chat
Platform API
Home
/
Chat
/
Platform API
/
User
This action allows a user to leave all group channels or channels with a specific custom type. This API is useful if you want to let a user leave a set of channels at once. To let a user leave only one of their group channels, use the Leave a channel API instead.
The following table shows a parameter that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of the user. |
The following table shows a property of the HTTP request that this action supports.
Optional
Property name | Type | Description |
---|---|---|
custom_type | string | Specifies a custom channel type. Only one custom type can be specified. |
If successful, this action returns an empty response body.
In the case of an error, an error object like below is returned. See the error codes section for more details.