Skip to content
Provisioning API/API Reference/
/
Updates a draft sender in...

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

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

Delete sender for projectGA

Request

Marks a sender for removal. Once requested the sender will be active for 60 days to deliver final messages. After 60 days it will be removed.

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.

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

Responses

Sender marked for delete after 60 days.

Response
No content

Updates a draft sender in projectGA

Request

Updates a draft sender in project.

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.

Bodyapplication/jsonrequired

Supported sender fields to update

statusstring

Create as draft or submit. Defaults to draft.

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

Sender details and information.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "SUBMIT",
    "details": {
      "adminPhoneNo": "+48777777777",
      "name": "Test Name",
      "logoImage": "https://example-logo-image.com",
      "topLevelCategoryCode": "019",
      "midLevelCategoryCode": "0006",
      "subLevelCategoryCode": "0001"
    }
  }'

Responses

Updated sender in project

Bodyapplication/json
plusFriendIdstringrequired

PlusFriend ID

idstring

The unique ID of the sender.

statestring

The current state of the sender.

Enum"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"
changesobject

Any pending changes to the sender.

detailsobject

Sender details and information.

createdstring

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

modifiedstring

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

Response
application/json

Response when successfully update a sender.

{
  "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  "state": "ACTIVE",
  "changes": {
    "status": "REJECTED",
    "details": { … }
  },
  "details": {
    "adminPhoneNo": "+48777777777",
    "name": "Test Name",
    "logoImage": "https://example-logo-image.com",
    "topLevelCategoryCode": "019",
    "midLevelCategoryCode": "0006",
    "subLevelCategoryCode": "0001"
  },
  "created": "2023-02-23T11:28:51.194Z",
  "modified": "2023-02-23T11:28:51.194Z"
}

Lists activities on senderGA

Request

Paginated list of activities for sender. Ordered from the most recent one to the oldest one.

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.

Query
pageSizenumber[ 1 .. 100 ]

The page size requested.

pageTokenstring

The page token if retrieving the next page from a previous query.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities?pageSize=1&pageToken=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Recent activities on sender

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

notificationsArray of objects(KakaotalkSenderNotificationDto)required
notifications[].​typestringrequired
Enum"ACTIVE""COMMENT_ADDED""CREATED""DRAFT""EDITED""IN_PROGRESS""INACTIVE""REJECTED"
notifications[].​createdstring
notifications[].​authorstring
notifications[].​commentstring
previousPageTokenstring

Encoded token to use in list request to fetch previous batch of entries.

nextPageTokenstring

Encoded token to use in list request to fetch next batch of entries.

Response
application/json

Response for all sender activities.

{
  "totalSize": 2,
  "pageSize": 50,
  "notifications": [
    { … },
    { … }
  ]
}

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