Leave group channels

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.

Since this API can't be called for a deactivated user, ensure that the leave_all_when_deactivated property of the user is set to its default value of true to let the user leave all joined group channels upon deactivation.

PUT https://api-{application_id}.sendbird.com/v3/users/{user_id}/my_group_channels/leave

The following table shows a parameter that this action supports.

The following table shows a property of the HTTP request that this action supports.

{
    "custom_type": "art"
}

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.

{
    "message": "\"User\" not found.",
    "code": 400201,
    "error": true
}