Skip to content
Provisioning API/API Reference/
/
Compare two templates

Provisioning API (1.2.36)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
Languages
Servers
Production server
https://provisioning.api.sinch.com
Staging server from master branch
https://provisioning-api.int.staging.sinch.com
Staging server from dev branch
https://provisioning-api-dev.int.staging.sinch.com
Internal production server for admin authorization
https://provisioning-api.unauth.int.prod.sinch.com
Internal staging server from master branch for admin authorization
https://provisioning-api.unauth.int.staging.sinch.com
Internal staging server from dev branch for admin authorization
https://provisioning-api-dev.unauth.int.staging.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

WhatsApp Accounts

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

Operations

WhatsApp

he WhatsApp endpoint enables programmatic login to your WhatsApp account and retrieval of its details.

Operations

WhatsApp Flows

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

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 Solutions

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

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

Creates a comment for a templateGA

Request

Creates a comment for a template.

Security
BasicAuth and BearerAuth and OAuth2Staging and OAuth2Production and OAuth2StagingAdmin and OAuth2ProductionAdmin
Path
projectIdstringrequired

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

templateNamestringrequired

The unique name of the template.

languageCodestring(WhatsappTemplateLanguagesEnum)required

The language code of the specific template.

Enum"AF""AR""AZ""BG""BN""CA""CS""DA""DE""EL"
Bodyapplication/jsonrequired

Comment data

commentstring[ 1 .. 65535 ] charactersrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "comment": "Example comment."
  }'

Responses

Created comment for a template

Bodyapplication/json
typestringrequired
Value"CREATED"
commentstringrequired
createdstring
Response
application/json
{
  "type": "CREATED",
  "comment": "Example comment",
  "created": "2023-01-19T13:11:08.204Z"
}

Compare two templatesGA

Request

Compare two templates.

Security
BasicAuth and BearerAuth and OAuth2Staging and OAuth2Production and OAuth2StagingAdmin and OAuth2ProductionAdmin
Path
projectIdstringrequired

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

templateNamestringrequired

The unique name of the template.

languageCodestring(WhatsappTemplateLanguagesEnum)required

The language code of the specific template.

Enum"AF""AR""AZ""BG""BN""CA""CS""DA""DE""EL"
Bodyapplication/jsonrequired

Compare data

templatesArray of objects(WhatsappInputTemplateCompareIdentifierDto)= 1 itemsrequired

List of templates

templates[].​templateNamestring^[a-z0-9][a-z0-9_]*[a-z0-9]$required

Template name

templates[].​templateLanguagestringrequired

Template language

Enum"AF""AR""AZ""BG""BN""CA""CS""DA""DE""EL"
timeframestring

Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request

Default "7"
Enum"30""60""7""90"
endTimestampnumber(timestamp)

End of timeframe

Default 1774337017857
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "templates": [
      {
        "templateName": "templateName2",
        "templateLanguage": "PL"
      }
    ],
    "timeframe": "60",
    "endTimestamp": 1694612898734
  }'

Responses

Compared template response

Bodyapplication/json
templatesArray of objects(WhatsappTemplateCompareIdentifierDto)required

List of templates

templates[].​namestringrequired

Template name

templates[].​languagestringrequired

Template language

Enum"AF""AR""AZ""BG""BN""CA""CS""DA""DE""EL"
templates[].​blockOrdernumberrequired

Order of block rate

templates[].​messageSendsnumberrequired

Message send number

templates[].​topBlockReasonstringrequired

Block reason

Enum"NO_LONGER_NEEDED""NO_REASON""NO_REASON_GIVEN""NO_SIGN_UP""OFFENSIVE_MESSAGES""OTHER""OTP_DID_NOT_REQUEST""SPAM""UNKNOWN_BLOCK_REASON""UNRECOGNIZED"
Response
application/json
{
  "templates": [
    { … },
    { … }
  ]
}

Bundles

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

Operations

KakaoTalk Categories

The KakaoTalk 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

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

Conversation

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

Operations

RCS Accounts

Operations

RCS Questionnaire

Operations

RCS Senders

Operations