Skip to content
Provisioning API/
/WhatsApp Solutions

Provisioning API (1.2.14)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
Languages
Servers
Production server
https://provisioning.api.sinch.com/

Webhooks

Webhooks allow the Sinch servers to communicate with your server backend. The webhooks endpoint lets you create, update, and delete webhooks programmatically.

Operations

Bundles

The bundles endpoint allows you to create and manage bundles of account resources.

Operations

Conversation

The Conversation endpoints allows you to retrieve about channels used with Conversation API.

Operations

WhatsApp

The WhatsApp endpoint allows you to programmatically log in to and get details of your WhatsApp account.

Operations

WhatsApp Templates

The WhatsApp template endpoint offers a way for you to manage your WhatsApp templates that can be used with the Conversation API. The WhatsApp templates are a requirement to send the initial outbound messages in the WhatsApp API.

Operations

WhatsApp Senders

A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users.

Operations

WhatsApp Accounts

The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.

Operations

WhatsApp Flows

The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project.

Operations

WhatsApp Solutions

The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions.

Operations

List all solutions in projectGA

Request

Returns a list of solutions for the specified project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/solutions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of solutions

Bodyapplication/json
solutionsArray of objects(WhatsappSolutionDto)required

List of solutions.

solutions[].​idstringread-onlyrequired

The unique ID of the solution

solutions[].​detailsobjectrequired
solutions[].​details.​namestringrequired

The name of the solution.

solutions[].​assignedbooleanread-onlyrequired

If project has been assigned to this solution.

solutions[].​partnerAppobjectread-only
solutions[].​ownerAppobjectread-only
Response
application/json

Response with solutions.

{
  "solutions": [
    { … },
    { … },
    { … }
  ]
}

Create solution for projectGA

Request

Returns all solutions for a project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

Solution data

detailsobjectrequired
details.​namestringrequired

The name of the solution.

accessTokenstringrequired

The accessToken received from the authResponse, returned when completing the embedded solution flow.

businessManagerstringrequired
Enum"SINCH_BR""SINCH_MX""SINCH_UK"
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/solutions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accessToken": "bdc64493-67f6-47df-be58-37f1431de555",
    "businessManager": "SINCH_UK",
    "details": {
      "name": "Test name"
    }
  }'

Responses

Solutions

Bodyapplication/json
solutionsArray of objects(WhatsappSolutionDto)required

List of solutions.

solutions[].​idstringread-onlyrequired

The unique ID of the solution

solutions[].​detailsobjectrequired
solutions[].​details.​namestringrequired

The name of the solution.

solutions[].​assignedbooleanread-onlyrequired

If project has been assigned to this solution.

solutions[].​partnerAppobjectread-only
solutions[].​ownerAppobjectread-only
failedSolutionsArray of objects(WhatsappFailedSolutionDto)required

List of failed solutions.

failedSolutions[].​partnerAppIdstringread-onlyrequired

The unique ID of the Tech Provider Meta App.

failedSolutions[].​errorCodestringread-onlyrequired
Enum"ACTIVATION_FAILED""CREATION_FAILED""UNRECOGNIZED"
failedSolutions[].​errorMessagestringread-only

Human readable message.

Response
application/json

Response when successfully creating a solution.

{
  "solutions": [
    { … },
    { … },
    { … }
  ],
  "failedSolutions": []
}

Get solution for projectGA

Request

Returns a solution for a project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

solutionIdstringrequired

The unique ID of the solution.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/solutions/{solutionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Solution

Bodyapplication/json
idstringread-onlyrequired

The unique ID of the solution

detailsobjectrequired
details.​namestringrequired

The name of the solution.

assignedbooleanread-onlyrequired

If project has been assigned to this solution.

partnerAppobjectread-only
ownerAppobjectread-only
Response
application/json

Response with assigned solution.

{
  "id": "123",
  "details": {
    "name": "Test name"
  },
  "ownerApp": {
    "id": 456,
    "name": "Test owner app name"
  },
  "partnerApp": {
    "id": 789,
    "name": "Test partner app name"
  },
  "assigned": true
}

KakaoTalk Templates

The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API.

Operations

KakaoTalk Categories

The KakoaTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API.

Operations

KakaoTalk Senders

The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API.

Operations

RCS Accounts

The RCS endpoint offers you a way to manage your RCS accounts.

Operations

RCS Questionnaire

Manage your RCS questionnaires.

Operations

RCS Senders

The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API.

Operations

RCS Upscales

The RCS upscales endpoint offers a way for you to manage your RCS upscales.

RCS Upscale Senders

The RCS upscaleSenders endpoint offers a way for you to manage your RCS upscaled senders.