Skip to main content
Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Organization

    Create an application

    Creates an application.

    HTTP request

    POST https://gate.sendbird.com/api/v2/applications

    Request body

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

    Properties
    RequiredTypeDescription

    app_name

    string

    Specifies the unique name of the application. This parameter is case-insensitive.

    region_key

    string

    Specifies the code of the region. Acceptable values are listed on the Sendbird Dashboard under Account > Organization settings > General > API regions.

    {
    "app_name": "sendbird_application_production",
    "region_key": "tokyo-1"
}

    Response

    If successful, this action returns an application resource in the response body.

    {
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "app_name": "sendbird_application_production",
    "api_token": "b0ar34e7acfa15fa2732c249aaf9e8f1e5bd3ew1",
    "region": {
        "region_key": "tokyo-1",
        "region_name": "Tokyo, Japan"
    },
    "created_at": "2020-10-18T06:10:59Z"
}

    In the case of an error, an error object is returned. A detailed list of error codes is available here.