SEsendbird
User

Leave my group channels

Changed on

Leave my 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 <code>leave_all_when_deactivated</code> property of the user is set to its default value of true to let the user leave all joined group channels upon deactivation.

https://sendbird.com/docs/chat/platform-api/v3/user/managing-joined-group-channels/leave-group-channels#1-leave-group-channels

user_id
Type: string
Description: Specifies the unique ID of the user to leave all joined group channels.

put/v3/users/{user_id}/my_group_channels/leave

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

user_idstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

custom_typestring

Response

Successful response

EmptyObjectResponse required

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • info

      added the new optional header request parameter api-token

    • info

      the request property became optional

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional