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

    Copy application settings

    Copies and applies settings of an application to another application within an organization. Settings including global settings, channel settings can be copied while unique information such as ID and name of an application are not copied. The applications must be in the same Sendbird server region.


    HTTP request

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

    Request body

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

    Properties
    RequiredTypeDescription

    from_app_id

    string

    Specifies the unique ID of the application to copy the settings.

    to_app_id

    string

    Specifies the unique ID of the application to apply the copied settings.

    Note: The Sendbird applications specified in from_app_id and to_app_id must be in the same Sendbird server region.

    {
      "from_app_id": "18BD5E50-140A-4B3F-BA9E-876F3B508D44",
      "to_app_id": "0BAF19BE-2C80-477C-8A79-7A225F573195"
    }
    

    Response

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

    {
        "app_id": "0DAF19BE-3C80-477C-8A79-7A225F573196",
        "app_name": "Target App",
        "api_token": "b0ar34e7acfa15fa2732c249aaf9e8f1e5bd3ew1",
        "region": {
            "region_key": "north-virginia-2",
            "region_name": "North Virginia 2, USA"
        },
        "created_at": "2021-07-30T02:16:08Z"
    }
    

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