Provisioning API Release Notes

See how the Provisioning API is evolving and find out about new features and bug fixes.

0.1.25

2023-09-14

KakaoTalk

Added

Added endpoint to remove template drafts.

New Features

Added Mexico business manager for US region.
Allowing Brazil business manager to be used for on premise senders in BR region.

Changed

Changed validation: components are optional for template draft.

Added

Added SINCH_MX business manager for US region.
Allowing Brazil business manager to be used for on premise senders in BR region.

0.1.24

2023-09-11

KakaoTalk

Added

Added endpoint to get list of template activities.
Added endpoint to create template comment.

New Features

Fields about and photoUrl are made optional.
Added new values for sender tpsPlan - XXLARGE and XXXLARGE .

Changed

Changed about and photoUrl for sender properties to optional.

Added

Added new get endpoint to retrieve stickerpack for a sender.
Added new values for sender tpsPlan - XXLARGE and XXXLARGE .

0.1.23

2023-08-28

Added

Added new status DISABLED for templates. Allow editing DISABLED status.

KakaoTalk

Added

Added endpoint to get list of categories for template.

0.1.22

2023-08-07

Common

Improvement of services

0.1.21

2023-07-10

Changed

Return an error if the combination of deployment region, sender type and business manager is not valid. See sender creation endpoint for current valid combinations.
Added Brazil deployment region.
Remove unsupported SA, AS and AU regions.
Removed deprecated field value for buttons components in templates.
Fixed deletion of edited templates in APPROVED or PAUSED statuses.

KakaoTalk

Added

Added endpoint to create KakaoTalk templates.

RCS

Changed

Changed inverted dimensions for rcs sender banner - height 448 px and width 1440 px .

0.1.20

2023-06-28

Changed

Fixed file uploading for update template.

0.1.19

2023-06-21

Changed

Corrected the response for the edited sender.

0.1.18

2023-06-19

Added

Added version 2 for templates.
Added Message Template header type LOCATION .

Changed

A telegram channel with no followers unexpectedly threw an error. It now correctly returns 0 followers.

0.1.17

2023-06-01

Changed

Fixed deleting templates for IN_PROGRESS state.

0.1.16

2023-05-26

Breaking changes

Rename errorMessage to rejectionCode in template.

Changed

Renamed errorMessage to rejectionCode in template.

0.1.15

2023-05-26

New Features

Add new fields for authentication template.
Add errorMessage field if template is rejected.
Allow editing APPROVED and PAUSED template.

Added

Added otp button.
Added new field codeExpirationMinutes in footer component dto.
Added errorMessage field to template. Possible values: ABUSIVE_CONTENT , INCORRECT_CATEGORY , INVALID_FORMAT , NONE , SCAM , UNRECOGNIZED . The field is only populated if status is REJECTED and contains the rejection reason from Meta.
Added new field addSecurityRecommendation in body component dto.
Allow editing APPROVED and PAUSED templates.

Changed

text property for body and footer component are optional because of AUTHENTICATION category.

0.1.14

2023-05-25

Common

Breaking changes

For error bad request error (400, invalid_input ) texts in validationErrors are changed. These should not be used for validation errors to the end user and are primarily intended to be used for debugging.

Changed

Updated validation errors message to fix some grammatical errors. All enum fields will now specify which enums are valid.

New features

Add new field to template allowCategoryChange which is allowing Meta to change the template category

Added

Added optional allowCategoryChange field to template creation.
Added optional wabaId for account endpoints responses.

Bundles

Changed

Removed ML_INTENT_SENTIMENT_ANALYSIS from conversation webhooks triggers.
Removed UNSPECIFIED_TRIGGER and UNRECOGNIZED from input bundles conversation webhooks triggers.

0.1.13

2023-05-16

Added

Added new field errorCode for sender. Possible values:
- NOVA_ACCOUNT_ID_CONFLICT
- NO_NOVA_ACCOUNT_ID
- PROJECT_ID_CONFLICT
- NO_PROJECT_ID
- CANNOT_ASSIGN_CREDIT_LINE
- CANNOT_SUBSCRIBE_TO_WEBHOOK
- NO_PRICING_PLAN
- CANNOT_ASSIGN_SYSTEM_USER
- NO_VERIFIED_PHONE_NUMBER
- CANNOT_GET_WABA_DETAILS
- MULTIPLE_WABA_FOR_PROJECT_ID
- NOT_VERIFY_BUSINESS_VIA_WHATSAPP
- CANNOT_CREATE_NEW_WHATSAPP_BOT
- CANNOT_REGISTER_NEW_WHATSAPP_BOT
- FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES
- NOT_VERIFIED_REQUESTED_PHONE_NUMBER
- DUPLICATES_ON_SENDER_PHONE_NUMBER
- CANNOT_CREATE_WABA_FOR_BUSINESS
- CANNOT_SUBSCRIBE_TO_CLOUD_API
- CANNOT_GET_DETAILS_FOR_CLOUD_API
- CANNOT_REGISTER_TO_CLOUD_API
- UNKNOWN_ERROR
- NO_CERTIFICATE_AVAILABLE
- UNRECOGNIZED
- errorReason returns a string with error details

0.1.12

2023-04-26

Deprecated fields

Add text property for buttons components which replaces value property. text should be used. value will be removed June 1, 2023.

Breaking Changes

The state field for account is returned only if the account is created.
Available state values for account - ONBOARDED , PENDING_FACEBOOK_VERIFICATION , REJECTED .

Added

Remove NOT_REGISTERED and REQUEST for state in account response. Available only: ONBOARDED , PENDING_FACEBOOK_VERIFICATION , REJECTED .
state for get account is optional.
Add text property for buttons components which replaces value property. value is deprecated and will be removed in a future update

0.1.11

2023-04-05

Added

Add WHATSAPP_SENDER_DAILY_LIMIT_CHANGED , WHATSAPP_SENDER_QUALITY_RATING_CHANGED and WHATSAPP_TEMPLATE_STATUS_UPDATED webhook trigger.

KakaoTalk

Changed

Fixed missing created and modified date for template.

0.1.10

2023-03-27

Breaking Changes

Only new template categories allowed: AUTHENTICATION , MARKETING and UTILITY from April 3, 2023

Added

Added new template categories AUTHENTICATION , UTILITY .
Added new template status PAUSED .

Changed

Improve errors for create long lived access token endpoint.

0.1.9

2023-03-13

KakaoTalk

Added

Added list endpoint for sender.
Added get endpoint for sender.
Added endpoint to get and list templates.

Breaking Changes

Renamed facebookManagerId to clientBusinessManagerId
Only new template categories allowed: TRANSACTIONAL , MARKETING and OTP
Removed endpoint to list account, sender and template activity ( */activity )

Added

Added endpoint to list account, sender and template activities ( */activities ).

Changed

Improve errors for list WABA and create long lived access token endpoint.
Rename facebookManagerId to clientBusinessManagerId .
Allow new template categories when creating templates: TRANSACTIONAL , MARKETING and OTP .
Removed endpoint to list account, sender and template activity ( */activity ).
*/activity endpoints are deprecated.

0.1.8

2023-02-28

Bundles

Added

Added current state field for bundle response.

Changed

Fixed triggering webhook if conversation app had set sms credentials.

0.1.7

2023-02-08

Changed

Additional validation of the phoneNumberId used to create the ES.
Improve errors for list WABA and create long lived access token endpoint.

0.1.6

2023-02-07

New features

Added capability to specify which Facebook Business Manager to use when getting temporary login url.

Added

Improved returned errors for endpoints: create a long lived access token and list WhatsApp Business Accounts details.
Added optional businessManager to get temporary URL for Facebook login.

0.1.5

2023-01-31

New features

Added capability to specify which Facebook Business Manager to use when creating an account or sender.

Added

Added optional businessManager to Account and Embedded Signup Sender creation.

Changed

Fixed webhook for WHATSAPP_TEMPLATE_COMMENT_ADDED .
Fixed webhook for WHATSAPP_ACCOUNT_COMMENT_ADDED .
Fixed fetching template / senders.

RCS

Breaking changes

Change the following trigger values:
- RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED -> RCS_SENDER_COMMENT_ADDED
- RCS_SENDER_CHANGE_REQUEST_REJECTED -> RCS_SENDER_REJECTED
- RCS_SENDER_CHANGE_REQUEST_DONE -> RCS_SENDER_CREATED

Added

Added validation for sender.

Changed

Change values for webhook trigger: RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED -> RCS_SENDER_COMMENT_ADDED , RCS_SENDER_CHANGE_REQUEST_REJECTED -> RCS_SENDER_REJECTED and RCS_SENDER_CHANGE_REQUEST_DONE -> RCS_SENDER_CREATED .

Webhook

New features

Added optional comment field for webhook payload.

Added

Add values for comment field for webhook payload.

Conversation

Breaking Changes

The channel information will now contain a field status which will be the underlying Conversation API channel status. If the call to the relevant API fails for some reason, the status will be displayed as ERROR. For both ERROR and FAILED there will be a value in the statusDescription field explaining the reason. Unlike previously, the channel information will only be populated if the status is ACTIVE.

Changed

Update all channel endpoints to contain Conversation API channel status. Unless the status is ACTIVE, the channel information will not be displayed.

0.1.4

2023-01-16

New features

Added filtering and sorting for list senders.
Added returned values for qualityRating and dailyLimit .

Breaking changes

Changed response http code to 201 for:
- create login
- create template
If no list activity for sender / template /account it will be return empty array. Previous it was returned 404 error.

Added

Add values for qualityRating : GREEN , RED , YELLOW and for dailyLimit : NOT_SET , TIER_50 , TIER_250 , TIER_1K , TIER_10K , TIER_100K , TIER_UNLIMITED .
Add query options for listSenders - filter by senderState , sort by name , state , created , modified and sort direction asc and desc .

Changed

Fixed returning changes after sender update.
Fixed returning created and modified dates for sender.
Change http status code to 201 for WhatsApp create login endpoint and create template endpoint.
Fixed filtering by templateStatus .
Changed fit if photoUrl for sender image is too big to cover .
Changed restricted domains for url button: facebook.com , fbcdn.net , tfbnw.net , instagram.com , wa.me , whatsapp.com .
Improve validation for example button - is only allowed for dynamic url.
Return empty array of notifications for list activity if no exist.

Conversation

Breaking Changes

Instagram channel information has changed to show new values. Previous implementation erroneously showed the same information as Facebook Messenger senders.

Changed

Updated Instagram channel information endpoint to show real Instagram values.

RCS

New features

Added filtering and sorting for list senders.
Added list of supported countries for suppliers.
Added endpoints:
- create sender comment.
- list sender activity.

Added

Add query options for listSenders - filter by senderState , sort by name state , created , modified and sort direction asc and desc .
Add supported supplier countries: BR , CA , DE , ES , FR , GB , IE , IN , KW , MX , NG , NL , NO , PL , US .
Added descriptions for RCS sender API.
Added endpoint to create sender comment.
Added endpoint to list sender activity.

Changed

Fixed returning created and modified dates for sender.
Return empty array of notifications for list activity if no exist.
Fixed get sender and list senders - filter by projectId .

Bundles

Breaking Changes

Changed response http code to 201 for create bundles.

Changed

Change http status code to 201 for bundles create endpoint.

Webhooks

Breaking Changes

Changed response http code to 201 for create webhooks.

Changed

Change http status code to 201 for webhooks create endpoint.

0.1.3

2022-12-20

Added

Added isEmbeddedSignup for Account response. Based on this value, it can be determined whether the account was created using Embedded Signup or On Behalf of.

Changed

Increased the allowed length for sender about field from 128 to 139 characters.

0.1.2

2022-12-13

Common

New features

Added x-b3-traceid in response headers. All responses, if request contains valid authorization headers, will return the header. This can be used when reporting errors or problems in the functioning of the API.
All errors, if request contains valid authorization headers, has content-type: application/json and body with errorCode , message , resolution .

Added

Added x-b3-traceid in headers if request is proxying to microservices.

Changed

Changed all error responses to JSON Error format.

New features

This release adds the possibility to create an Embedded Signup sender which will be hosted on the WhatsApp Cloud API from creation.

Breaking Changes

Dropped support for WA Standalone API. All senders are now created to be used with Conversation API. The sender endpoints will have the two following changes:
- Removed conversationApiEnabled as it now will always be true .
- Removed callbackUrl as the callback will be set internally though Conversaiton API.
Create comment endpoint for all resources have the fields id , modified , user removed. The response will now be the same format as the list activities endpoints.

Added

Added an optional flag to set up the sender for cloud api if it's embedded signup.

Changed

Removed id , modified , user from create comment response.
Removed flag conversationApiEnabled when creating sender.
Fixing listSenders endpoint - adding missing internal pagination.
Removed sender callbackUrl for OBO sender. Changed sender details.
Limited sender state for update sender has to be update.
Until Sender is not ACTIVE showing data in changes .
Fixed a bug where direct enterprise customers could not see resources if having multiple projects.
Fixed a bug on creation message template if examples is empty array.

RCS

RCS is currently in active development. This release contains pre-release functionality and can be requested to trial it.

Added

Added endpoint to list senders.
Added endpoint to creating sender.
Added endpoint to fetching sender.

0.1.1

2022-11-14

Breaking Changes

Template have one breaking changes:
- whatsappId field would previously return an empty string if not set. Field will now not be set.

Changed

Hide whatsappId if there is no value.
Update documentation to clarify which regions are supported for senders.
Fixed remove sender photo url.
Fixed sender callbackUrl for OBO sender if conversationApiEnabled equals false .

Conversation

New features

Added new endpoints to query Instagram and Facebook Messenger information for a Conversation Api App which has those channels configured. Channel information is now supported for Instagram, Messenger, Telegram and Viber Bots.

Added

Added endpoint to query Instagram channel information for a Conversation Api App.
Added endpoint to query Facebook Messenger channel information for a Conversation Api App.

0.1.0

2022-11-09

New features

WhatsApp On Behalf of Senders

This release adds the possibility to create On Behalf Of (OBO) senders. Previously senders had to be created through the Embedded Signup (ES) process.

Creating a OBO sender requires more steps than a ES sender. The process should follow the following steps:

Create a new account. Unlike ES an account will need to be created first. This will allow Sinch to create a WABA under the Facebook Manager Id specified.
Authorize Sinch to manage the WABA on behalf of the end user and wait for the account to be onboarded.
Create a new OBO sender. Once the account is onboarded a sender can be created for the project.
If using a customer provided phone number: Trigger registration and verification of the phone number.

Both types of sender are the same once onboarded. Template creation is the same process for both types.

Once a project has created either a ES or OBO sender, it is not possible to create the other type for the same project. If attempting to create an OBO sender in a ES project, an error code will be returned and vice versa.

Breaking Changes

Activity lists for all resource types have the following changes:
- Updated type field enum to reflect the status of the resource type.
- Removed createdBy and modifiedBy fields. These fields referenced internal users not usable by an API user.
- Removed description and title fields from activity list. These fields contained parsed english strings. Users should use the type fields.
Sender details have the following breaking changes:
- Region enum values has changes. Previous enum listed values as EUROPE , AMERICA , ASIA , AUSTRALIA and SOUTH_AMERICA . New values are respectively EU , US , AS , AU and SA . Only EU and US are currently supported for creating senders.
- Number provider type has moved from details.numberProvider to numberProvider in the sender object.
- The sender detail fields would previously return an empty string if not set. The following fields will now not be set instead: description , email , address , websiteOne , websiteTwo , callbackUrl .
Webhook triggers:
- Previously a trigger WHATSAPP_TEMPLATE_IN_PROGRESS existed in the allowed webhook triggers. This trigger has been removed as the In Progress state is a user initiated transition.
- Webhook trigger WHATSAPP_TEMPLATE_DELETED did not work as intended. It has been removed temporarily and will be added in a future version when fully working.

Added

Added sender callbackUrl for OBO sender. Changed sender details.
Add flag conversationApiEnabled when creating a OBO sender.
Add optional saveDraftOnFailure flag to delete template if submission fails. Defaults to false.
Add endpoint to delete pending or rejected changes to a sender.
Add errors for invalid media file size and internal media upload error for template submission.
Add error field containing reason for error if sender is in state ERROR .
Add comment field to activity lists.
Add update sender endpoint.
Add endpoint to start verification register for OBO sender.
Add WHATSAPP_TEMPLATE_COMMENT_ADDED webhook trigger.
Add creating and listing comments for account.

Changed

Fixed remove unexpected "\n" from error resolution.
Fixed text header max length (allowed max 60 characters).
Fixed error message for sender photo url.
Add custom error resolution for message template submit errors.
Fix validation to not allow an empty list of buttons in a button component.
Fixed checking file dimension for sender photo url. Updated file requirements for sender photo url.
Fixed error if url leads to a page that does not exist.
Add generic mime type for download files from url. Applies to both template component media header example and photoUrl for senders.
Fixed internal server error when sending empty button components.
Remove mime type for template media header component example.
Fixed adding mp4 files as header example.
Fixed adding pdf files as header example
Temporarily remove WHATSAPP_TEMPLATE_DELETED webhook trigger.
Fixed validation for components BUTTONS - require at least one character for value .
Cache images for template header example and sender photo url on Sinch servers.
Trigger sender webhooks by relying on bot id instead of expecting project id.
Update documentation for sender OTP code verification.
Increase max template button text length to 25 characters and header text to 256 characters.
Update type field enum to reflect the statuses which are present in the corresponding resource type.
Allow all template categories ( both legacy and new ) when creating templates.
Fix method to delete draft and rejected templates.
Transition a change request to DRAFT before updating if the change request is REJECTED .
Fix template Kafka processor when payload is without template id.
Change error for sender verification when registration has not occured yet.
Fix validation issue when template contains more than ten variables.
Remove createdBy and modifiedBy fields from activity lists.
Fix validation for OBO sender verification erroneously allowing empty verification code.
Remove WHATSAPP_TEMPLATE_IN_PROGRESS webhook trigger.

Webhooks

Breaking Changes

Previous version allowed to register a webhook trigger with both ALL and a specific triggers such as WHATSAPP_TEMPLATE_APPROVED . Now only ALL is allowed if specified and if any more are provided an error is thrown.

Changes

Renaming Update Webhook to Replace Webhook ( PUT method) and adding Update Webhook ( PATCH method).
Do not allow other triggers along with ALL .

Bundles

Changes

Retry if Conversation API returns an error when setting App credentials.