latestOpenAPI 3.0.2MIT2026-08-1745267541.8 KB

bdb3e0c48bf7

App

Update an app

Updates a particular app as specified by the App ID. Note that this is a PATCH operation, so any specified field values will replace existing values. Therefore, if you'd like to add additional configurations to an existing Conversation API app, ensure that you include existing values AND new values in the call. For example, if you'd like to add new channel_credentials, you can get your existing Conversation API app, extract the existing channel_credentials list, append your new configuration to that list, and include the updated channel_credentials list in this update call.

patch/v1/projects/{project_id}/apps/{app_id}

Query parameters

update_maskstring[]

The set of field mask paths.

Request body

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.

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}"
}