Skip to content
Provisioning API/
/WhatsApp Accounts

Provisioning API (1.2.7)

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

Get account for projectGA

Request

Returns an account for a 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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Account

Bodyapplication/json
isEmbeddedSignupbooleanrequired

true if the Account was created through Embedded Signup. false otherwise.

businessManagerstringrequired

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK""UNRECOGNIZED"
compatibleRegionsArray of strings(WhatsappRegions)uniquerequired

Conversation API app regions the sender can be used for.

Items Enum"br""eu""us"
statestring

The current state of your account.

Enum"ONBOARDED""PENDING_FACEBOOK_VERIFICATION""REJECTED"
wabaIdstring

WhatsApp Business Manager ID.

changesobject

Any pending changes to the account.

detailsobject

Account details and information.

wabaBanStatestring

Ban state when account has been banned.

Enum"DISABLE""REINSTATE""SCHEDULE_FOR_DISABLE""UNRECOGNIZED"
wabaBanDatestring

The UTC Date Time in ISO 8601 for when account has been banned.

wabaEnabledForInsightsboolean

Template analytics status for account.

primaryBusinessLocationstring

Two-letter country code in ISO 3166 standard, specifying the country where business is based

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json

Response with an account.

{
  "state": "ONBOARDED",
  "isEmbeddedSignup": false,
  "businessManager": "SINCH_UK",
  "wabaId": "1234567890",
  "details": {
    "companyLegalName": "Legal name of company",
    "clientBusinessManagerId": "1234567890"
  },
  "wabaEnabledForInsights": false,
  "compatibleRegions": [
    "eu",
    "us"
  ]
}

Create account for projectGA

Request

Create the WhatsApp account for the project. Each project can only have one account.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

Account data

companyLegalNamestring[ 1 .. 255 ] charactersrequired

The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here.

clientBusinessManagerIdstring[ 1 .. 255 ] charactersrequired

The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name.

businessManagerstring

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK"
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyLegalName": "Legal name of company",
    "clientBusinessManagerId": "1234567890"
  }'

Responses

Account

Bodyapplication/json
isEmbeddedSignupbooleanrequired

true if the Account was created through Embedded Signup. false otherwise.

businessManagerstringrequired

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK""UNRECOGNIZED"
compatibleRegionsArray of strings(WhatsappRegions)uniquerequired

Conversation API app regions the sender can be used for.

Items Enum"br""eu""us"
statestring

The current state of your account.

Enum"ONBOARDED""PENDING_FACEBOOK_VERIFICATION""REJECTED"
wabaIdstring

WhatsApp Business Manager ID.

changesobject

Any pending changes to the account.

detailsobject

Account details and information.

wabaBanStatestring

Ban state when account has been banned.

Enum"DISABLE""REINSTATE""SCHEDULE_FOR_DISABLE""UNRECOGNIZED"
wabaBanDatestring

The UTC Date Time in ISO 8601 for when account has been banned.

wabaEnabledForInsightsboolean

Template analytics status for account.

primaryBusinessLocationstring

Two-letter country code in ISO 3166 standard, specifying the country where business is based

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json

Response when successfully creating an account.

{
  "isEmbeddedSignup": false,
  "businessManager": "SINCH_UK",
  "wabaId": "1234567890",
  "changes": {
    "status": "IN_PROGRESS",
    "details": { … }
  },
  "compatibleRegions": [
    "eu",
    "us"
  ]
}

Callbacks

Comment on account
post
Account onboarded
post
Account rejected
post
Account pending verification
post
Account business information changed
post

Update account for projectGA

Request

Update an account.

It is only possible to update an account that has been rejected. After update the status will be set to IN_PROGRESS.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

Supported account fields to update.

companyLegalNamestring[ 1 .. 255 ] characters

The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here.

clientBusinessManagerIdstring[ 1 .. 255 ] characters

The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyLegalName": "Update legal name of company",
    "clientBusinessManagerId": "1234567890"
  }'

Responses

Account

Bodyapplication/json
isEmbeddedSignupbooleanrequired

true if the Account was created through Embedded Signup. false otherwise.

businessManagerstringrequired

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK""UNRECOGNIZED"
compatibleRegionsArray of strings(WhatsappRegions)uniquerequired

Conversation API app regions the sender can be used for.

Items Enum"br""eu""us"
statestring

The current state of your account.

Enum"ONBOARDED""PENDING_FACEBOOK_VERIFICATION""REJECTED"
wabaIdstring

WhatsApp Business Manager ID.

changesobject

Any pending changes to the account.

detailsobject

Account details and information.

wabaBanStatestring

Ban state when account has been banned.

Enum"DISABLE""REINSTATE""SCHEDULE_FOR_DISABLE""UNRECOGNIZED"
wabaBanDatestring

The UTC Date Time in ISO 8601 for when account has been banned.

wabaEnabledForInsightsboolean

Template analytics status for account.

primaryBusinessLocationstring

Two-letter country code in ISO 3166 standard, specifying the country where business is based

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json

Response when successfully update an account.

{
  "state": "REJECTED",
  "isEmbeddedSignup": false,
  "businessManager": "SINCH_UK",
  "wabaId": "1234567890",
  "changes": {
    "status": "IN_PROGRESS",
    "details": { … }
  },
  "details": {
    "companyLegalName": "Legal name of company",
    "clientBusinessManagerId": "1234567890"
  },
  "wabaEnabledForInsights": true,
  "compatibleRegions": [
    "eu",
    "us"
  ]
}

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

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.

Operations