Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    Overview

    The Organization API allows you to list, view, create and manage Sendbird applications, their features, and members in an organization. A Sendbird application performs core functionalities and features for Sendbird Chat, Sendbird Calls, and Sendbird Desk.


    HTTP headers

    Each HTTP request should be authenticated with the organization API key in the request header. The unique API key can be found on Sendbird Dashboard under the account's Organization settings > General > API key. The organization API key can retrieve token information from all client apps.

    POST /api/v2/applications HTTP/1.1
    User-Agent: Mozilla/4.0 (compatible; MSIE5.01; Windows NT)
    Host: gate.sendbird.com
    Content-Type: application/json;charset=utf-8
    Content-Length: length
    Accept-Language: en-us
    Accept-Encoding: gzip, deflate
    Connection: Keep-Alive
    SENDBIRDORGANIZATIONAPITOKEN: {organization_api_key}
    ...
    

    Resource representation

    The following tables show the list of properties for application, feature, and member in an organization resource.

    List of application properties

    Property nameTypeDescription

    app_id

    string

    The unique ID of the application.

    app_name

    string

    The name of the application.

    api_token

    string

    The credential of the application for accessing the Chat API. It is an opaque string which should be submitted to the Sendbird server for application identification when requesting.

    created_at

    datetime

    The date and time when the application was created.

    region

    nested object

    The region information of the application.

    region.region_key

    string

    The unique key of the region where the application is running. Valid values are the following.
    - tokyo-1: Tokyo, Japan
    - seoul-1: Seoul, South Korea
    - singapore-1: Singapore
    - mumbai-1: Mumbai, India
    - sydney-1: Sydney, Australia
    - oregon-1: Oregon, USA
    - north-virginia-1: Northern Virginia 1, USA
    - north-virginia-2: Northern Virginia 2, USA
    - canada-central-1: Central Canada
    - frankfurt-1: Frankfurt, Germany

    region.region_name

    string

    The name of the region where the application is running.

    premium_features

    nested object

    Information about premium features used in the application.

    push_notification

    nested object

    The push notification settings used in the application.

    auto_event_message

    nested object

    The auto event message settings used in the application.

    List of feature properties

    Property nameTypeDescription

    auto_thumbnail

    boolean

    Indicates whether to turn on or off the thumbnail auto-generator feature. (Default: false)

    translation_tools

    boolean

    Indicates whether to turn on or off the message auto-translation feature. (Default: false)

    image_moderation

    boolean

    Indicates whether to turn on or off the image moderation feature. (Default: false)

    data_export

    boolean

    Indicates whether to turn on or off the data export feature.

    domain_filter

    boolean

    Indicates whether to turn on or off the domain filter feature. (Default: false)

    profanity_filter

    boolean

    Indicates whether to turn on or off the profanity filter feature. (Default: false)

    delivery_receipt

    boolean

    Indicates whether to turn on or off the delivery receipt feature.

    announcement

    boolean

    Indicates whether to turn on or off the announcements feature. (Default: false)

    supergroup

    boolean

    Indicates whether to turn on or off a Supergroup channel. (Default: false)

    advanced_analytics

    boolean

    Indicates whether to turn on or off the advanced analytics feature.

    message_search

    boolean

    Indicates whether to turn on or off the message search feature. (Default: false)

    List of member properties

    Property nameTypeDescription

    id

    int

    The unique ID of the member.

    role

    string

    The role given to the member.

    created_at

    datetime

    The date and time when the member was created.

    status

    string

    The account status of the member. Valid values are the following:
    - ACTIVE: Indicates that the member is active in the organization and the member can access features on the dashboard.
    - INACTIVE: Indicates that the member's account is deleted in the organization and the member can't access features on the dashboard.

    user.id

    int

    The unique user ID of the member.

    user.email

    string

    The email address of the member.

    user.date_joined

    datetime

    The date and time when the member joined the organization.

    user.is_active

    boolean

    Indicates whether the member's status is ACTIVE.

    user.profile.id

    int

    The unique ID of the member's profile.

    user.profile.nickname

    string

    The member's nickname.

    user.first_name

    string

    The member's first name.

    user.last_name

    string

    The member's last name.

    organization

    int

    The unique ID of the organization.

    organization_member_role

    object

    Detailed information about the member's role.


    Actions

    • API endpoints in this page are relative to the base URL allocated to your Sendbird application. In this page, the /applications endpoint refers to https://gate.sendbird.com/api/v2/applications.
    ActionHTTP request

    List applications

    GET /applications
    Retrieves a list of applications.

    Get an application

    GET /applications/{app_id}
    Retrieves a specific application.

    Create an application

    POST /applications
    Creates an application.

    Delete an application

    DELETE /applications/{app_id}
    Deletes a specific application.

    Copy application settings

    POST applications/copy_settings
    Copies and applies settings of an application to another application within an organization.

    List features

    GET /applications/{app_id/}features
    Retrieves a list of features used in an application.

    Update a feature

    PATCH /applications/{app_id}/features
    Turns on and off a feature for a specific application.

    List members

    GET /organization_members
    Retrieves a list of members of an organization.

    Get a member

    GET /organization_members/{member_id}
    Retrieves information about a specific member of an organization.

    Update a member

    PATCH /organization_members/{member_id}
    Updates the role of a specific member of an organization.

    Deactivate a member

    POST /organization_members/{member_id}/deactivate
    Deactivates a specific member of an organization.

    List predefined roles

    GET /organization_members/predefined_roles
    Retrieves a list of predefined roles which are provided by default in an organization.

    List custom roles

    GET /organization_members/custom_roles
    Retrieves a list of custom roles in an organization.