Skip to content
Provisioning API/API Reference/
/
Delete template for proje...

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

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

Get template in projectGA

Request

Returns a template for a project, with the specified name and language.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

plusFriendIdstringrequired

The unique ID of the sender.

templateCodestringrequired

The unique name of the template.

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

Responses

Template

Bodyapplication/json
codestringrequired

Registered delivery template code

idstring

The unique ID of the template.

statestring

The current state of the template.

Enum"APPROVED""REJECTED"
changesobject

Any pending changes to the template.

detailsobject

Template details and information.

createdstring

The UTC Date Time in ISO 8601 for when the template was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the template was last modified.

Response
application/json

Response when successfully creating a template.

{
  "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  "code": "S7yFqaKqJ8tsnBZH2CEd",
  "state": "APPROVED",
  "details": {
    "language": "EN",
    "messageType": "BASIC",
    "emphasizeType": "EMPHASIZE_TYPE_NONE",
    "categoryCode": "001001",
    "securityFlag": false,
    "name": "Example name",
    "content": "Example content",
    "extra": "Example extra",
    "ad": "Example ad",
    "title": "Example title",
    "subtitle": "Example subtitle",
    "imageName": "Example image name",
    "imageUrl": "https://example-image-url.com",
    "buttons": [ … ]
  },
  "created": "2023-02-24T10:19:31.372Z",
  "modified": "2023-02-24T10:19:31.372Z"
}

Delete template for projectGA

Request

Delete template that matches the template code.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

plusFriendIdstringrequired

The unique ID of the sender.

templateCodestringrequired

The unique name of the template.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Template deleted

Response
No content

Update a template in projectGA

Request

Updates an existing template with the request data.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

plusFriendIdstringrequired

The unique ID of the sender.

templateCodestringrequired
Bodyapplication/jsonrequired

Updating data

statusstring

Create as draft or submit. Defaults to draft.

Default "DRAFT"
Enum"DRAFT""SUBMIT"
detailsobject

Template details and information.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Updated template

Bodyapplication/json
codestringrequired

Registered delivery template code

idstring

The unique ID of the template.

statestring

The current state of the template.

Enum"APPROVED""REJECTED"
changesobject

Any pending changes to the template.

detailsobject

Template details and information.

createdstring

The UTC Date Time in ISO 8601 for when the template was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the template was last modified.

Response
application/json

Response when successfully updating a template.

{
  "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  "code": "S7yFqaKqJ8tsnBZH2CEd",
  "changes": {
    "status": "IN_PROGRESS",
    "details": { … }
  },
  "created": "2023-02-24T10:19:31.372Z",
  "modified": "2023-02-24T10:19:31.372Z"
}

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