App

Create an app

You can create a new Conversation API app using the API. You can create an app for one or more channels at once. The ID of the app is generated at creation and will be returned in the response.

post/v1/projects/{project_id}/apps

Request

Base URL
https://us.conversation.api.sinch.com
URL
https://us.conversation.api.sinch.com/v1/projects/{project_id}/apps
Auth
- HTTP basic
- or OAuth 2
  Client credentials
  Token URL: https://auth.sinch.com/oauth2/token

Request body

conversation_metadata_report_view'NONE' | 'FULL'

NONE - Omit metadata. FULL - Include all metadata assigned to the conversation.

display_namestring required

The display name for the app.

processing_mode'CONVERSATION' | 'DISPATCH'

Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.

Example request

{
  "channel_credentials": [
    {
      "channel": "WHATSAPP"
    }
  ],
  "display_name": "Sinch Conversation API Demo App 001"
}

Response

A successful response.

conversation_metadata_report_view'NONE' | 'FULL'

NONE - Omit metadata. FULL - Include all metadata assigned to the conversation.

display_namestring

The display name for the app.

idstring

The ID of the app. You can find this on the Sinch Dashboard.

processing_mode'CONVERSATION' | 'DISPATCH'

Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.

Example response

{
  "channel_credentials": [
    {
      "channel": "WHATSAPP"
    }
  ],
  "display_name": "Sinch Conversation API Demo App 001",
  "id": "{APP_ID}"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.