SEsendbird
Group channel

Cancel the registration of operators

Changed on

Unregister operators from a group channel

You can unregister operators in a group channel but keep them in the channel as members using this API.

https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/unregister-operators-from-a-group-channel#1-unregister-operators-from-a-group-channel

channel_url
Type: string
Description: Specifies the URL of the channel to cancel the registration of operators.

delete/v3/group_channels/{channel_url}/operators

Request

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

Path parameters

channel_urlstring required

(Required)

Query parameters

operator_idsstring required

Specifies an array of one or more operator IDs to unregister from the channel. The operators in this array remain as participants of the channel after losing their operational roles. Urlencoding each operator ID is recommended. An example of a Urlencoded array would be ?operator_ids=urlencoded_id_1,urlencoded_id_2.

delete_allboolean

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

EmptyObjectResponse required

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the optional property anyOf from the response with the status

    • info

      api operation id gcCancelTheRegistrationOfOperators removed and replaced with cancelTheRegistrationOfOperators

    • info

      added the new optional header request parameter api-token

    • info

      for the query request parameter operator_ids, the type was generalized from array to string

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional