/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Create an application

    Copy link

    Creates an application.


    HTTP request

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

    Request body

    Copy link

    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 Organization settings > General > API Key > Regions.

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

    Response

    Copy link

    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.