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

    Register operators to a group channel

    Copy link

    You can register one or more operators to a group channel using this API.

    HTTP request

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

    Parameters

    Copy link

    The following table shows a parameter that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the channel.

    Request body

    Copy link

    The following table lists properties of the HTTP request that this action supports.

    Required
    Property nameTypeDescription

    operator_ids[]

    array of strings

    Specifies an array of one or more user IDs to register as operators of the channel. If the channel in channel_url is private and the users in operator_ids aren't members of the channel yet, they need an invitation first. If the channel is a public group channel, they don't need an invitation. The maximum number of operators allowed per channel is 100.

    {
    "operator_ids": ["Jeff", "Glen", "Caroline"]
}

    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": "\"User\" not found.",
    "code": 400201,
    "error": true
}