Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    User

    Unregister operators from a group channel

    Copy link

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

    HTTP request

    Copy link
    DELETE https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/operators

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_url

    string

    Specifies the URL of the channel.

    operator_ids[]

    array of strings

    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.

    OptionalTypeDescription

    delete_all

    boolean

    Determines whether to cancel the registration of all operators and leave them as the members 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)

    ?operator_ids=Jeff,Glen

    Responses

    Copy link

    If successful, this action returns an empty response body.

    Error

    Copy link

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
    "message": "Invalid value: \"The list contains a non-operator id\".",
    "code": 400111,
    "error": true
}