SEsendbird
Open channel

Unregister operators from an open channel

Changed on

Unregister operators from an open channel

You can unregister operators in an open channel but keep them in the channel as participants using this API.

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

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

delete/v3/open_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

Determines whether to unregister all operators and leave them as the participants of the channel. When this is set to true, the operator_ids property isn't effective and doesn't need to be specified in the request. (Default: false)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

EmptyObjectResponse required

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • info

      api operation id ocCancelTheRegistrationOfOperators removed and replaced with unregisterOperators

    • 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

    • info

      added the media type application/json for the response with the status

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional