See how the Provisioning API is evolving and find out about new features and bug fixes.
2025-07-21
- Improvement of services
2025-07-21
- The webhook triggers
BILLING_CREDIT_LIMIT_BREACHEDandCONSENT_BATCH_COMPLETEare now deprecated and will be in a future version.
- Added new webhook trigger
BATCH_STATUS_UPDATE.
- Deprecated webhook triggers
BILLING_CREDIT_LIMIT_BREACHEDandCONSENT_BATCH_COMPLETE.
- The webhook triggers
BILLING_CREDIT_LIMIT_BREACHEDandCONSENT_BATCH_COMPLETEare now deprecated and will be in a future version.
- The webhook triggers
BILLING_CREDIT_LIMIT_BREACHEDandCONSENT_BATCH_COMPLETEare now deprecated and will be in a future version.
2025-07-21
- Enable Odido operator in NL for RCS launch.
2025-07-14
- Improvement of services
2025-07-07
- Improvement of services
2025-07-03
- Updated error for incorrectly formatted bundleId.
- Relax validation for creating and updating draft senders
- US country specific questions will not be forced yet when launching a Sender. However it will eventually be enforced for launch of a Sender.
- Updated error for incorrectly formatted webhookId.
2025-06-30
- Deprecated
usersAmountandstartDatefrom country specific questions, for France. These fields are no longer required, if provided the fields will be ignored. Fields will be removed from response by end of August.
- Added US country specific questions, that are required for launch in US.
2025-06-23
- Improvement of services
2025-06-16
filterCountriesandfilterBillingCategoriesadded for admin "list senders" endpoint.
- Add country and billing category filter to admin list senders
- Improved resolution in error message, when trying to launch sender in invalid state.
2025-06-05
- Improvement of services
2025-06-03
- Added new triggers
BILLING_CREDIT_LIMIT_BREACHEDandCONSENT_BATCH_COMPLETEfor conversation webhooks.
- Added update sender endpoint
- Restored update sender endpoint
2025-06-02
- Improvement of services
- Enabled Telia Norway.
2025-05-26
- Improvement of services
- Added Google agentId to senderDto.
2025-05-20
- Improvement of services
2025-05-19
- Adding ability to delete submitted templates by name
- Added new endpoint to delete Sender.
- Added delete sender endpoint
- Added Poland as supported country.
- Added unformatted phone number as an option to e.164 format for brand phone numbers.
2025-05-12
- Added SIREN as country specific question for France.
2025-05-12
- Improvement of services
2025-05-07
- Changed default value for
convApp.processingModetoDISPATCH.
Please review your configurations and update any dependencies accordingly.
2025-05-05
- Deprecated On-Behalf-Of (OBO) Sender creation, since Meta has announced End-Of-Life (EOL) in September 2025.
- Deprecated OBO Sender DTO.
2025-04-28
- Improvement of services
2025-04-22
- Added id to bundle's subproject return data
- Added Norway to the list of sender countries.
2025-04-15
- Improvement of services
2025-03-31
- Deprecated field
conversationApiAppfor sender endpoints.
- [
PROAPI-1764] Added theconversationApiAppDetailsfield to sender endpoints, providing details of the Conversation API app connected to the sender. (|#1936)
- Enabled
Telenor Norwayoperator. - Enabled
1und1 Germanyoperator. - Enabled
Telenor Swedenoperator.
2025-03-24
- Improvement of services
2025-03-24
- Added
CAROUSELcomponent for Message Template.
- Added
CAROUSELcomponent for Message Template.
2025-03-17
- Fixed a bug that prevented validation of some toll free international numbers.
2025-03-13
- Provisioning API for
RCSservice is GA.
- Deprecated field
callbackUrlin sender response. - Removed field
callbackUrlfrom sender input. It will be ignored, so it's not breaking.
- Fix validation for websites
urlto 255 characters. - Deprecated
callbackUrlin sender response, and removed from sender input. Webhooks should be used to get notifications about updates. Change is not breaking since input will be ignored.
- Deprecated
Create a long lived access tokenendpoint. - Deprecated
List WhatsApp Business Accounts detailsendpoint. - Deprecated request body for creating Embedded Sender.
- Added new request body for creating Embedded Sender.
- Added new required body for creating Embedded Sender where
wabaIdandphoneNumberIdare required. - Added sender
vertical-ALCOHOL,ONLINE_GAMBLING,OTC_DRUGSandPHYSICAL_GAMBLING.
- Deprecated request body for creating Embedded Sender where
facebookAccessTokenorfacebookCodewere required. - Deprecated endpoints:
Create a long lived access tokenandList WhatsApp Business Accounts details. - Deprecated endpoints:
Create a long lived access tokenandList WhatsApp Business Accounts details.
- Added Belgium to the list of sender countries.
- Added Austria to the list of sender countries.
- Added Slovakia and Czech Republic to the list of sender countries.
2025-03-03
- Enabled
T-Mobile CZoperator. - Enabled
Slovak Telekomoperator.
- Added
webhookDeliveryStatusespresenting the delivery status of webhooks to targets.
2025-02-20
- Improvement of services
2025-02-17
- Improvement of services
2025-02-10
- Improvement of services
2025-02-05
- Added
wrong_otperror to sender verification endpoint. - Added filtering by Conversation API app ID to the list senders endpoint.
2025-02-04
- Improvement of services
2025-01-29
- Fixed a bug causing list templates and list templates by name endpoints to sometimes break.
2025-01-28
- Fixed a bug causing update sender endpoint to fail when emails, phones or websites array is set to null.
- Added values
ACTION_COMPOSE&ACTION_OPEN_URL_IN_WEBVIEWforTestNumberFeatures. - Allow specifying either email address or phone number to request sender launch.
2025-01-21
- Improvement of services
2025-01-16
- Improvement of services
2025-01-16
- Improvement of services
2025-01-16
- Improvement of services
2025-01-16
- Changed to accept
phoneNumberforSINCHphone number provider (OBO sender). - Removed old deprecated template category. Currently available categories
AUTHENTICATION,MARKETING,UTILITY.
2025-01-13
- Improvement of services
2025-01-08
- Removed non-standard country codes from the sender endpoints response.
2024-12-20
- Improvement of services
2024-12-16
- Improvement of services
2024-12-16
- Added
WHATSAPP_WABA_ACCOUNT_CHANGEDwebhook trigger. - Added
primaryBusinessLocationproperty to account endpoints response.
2024-12-11
- Added
WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATEwebhook trigger.
2024-12-09
- Added
RCS_SENDER_OPERATOR_STATUS_UPDATEDwebhook trigger. - Added ability to relaunch sender using launch endpoint.
- Added status
INVALID_IN_GOOGLE_MY_BUSINESSforcountryStatus.
2024-12-05
- Deprecated
packageNameandsignatureHashproperties in template OTP button input. - Deprecated field
cloudApifor sender endpoints response.
- Added
ZERO_TAPto the list of allowed values forotpTypeproperty in template OTP button input. - Added
AE,AU,BH,CA,CH,GB,ID,IN,JP,KR,SG,ZAto the list of allowed values formetaLocalStorageproperty in sender endpoints input and response.
- Removed previously deprecated properties
tpsProcessingandtpsPlanas well as optional propertytpsChangedin sender endpoints response. - Removed previously deprecated template categories
ACCOUNT_UPDATE,ALERT_UPDATE,APPOINTMENT_UPDATE,AUTO_REPLY,ISSUE_RESOLUTION,OTP,PAYMENT_UPDATE,PERSONAL_FINANCE_UPDATE,RESERVATION_UPDATE,SHIPPING_UPDATE,TICKET_UPDATE,TRANSACTIONALandTRANSPORTATION_UPDATEin template endpoints response.
- Added
add_test_number_not_allowed_before_launcherror to sender endpoints. - Added
USas supported country for RCS.
- Changed
callbackUrlto be optional for sender launching.
2024-11-22
- Improvement of services
2024-11-18
- Changed errors for image validation. Instead of two errors
file_dimensions_too_smallandfile_dimensions_too_bigit will be onefile_has_wrong_dimensionswith image requirements.
2024-11-11
- Added
screenshotUristo general questionnaire, as optional field. - Added
Netherlandsas supported country for RCS.
2024-11-04
- Improvement of services
2024-10-28
- Removed
Stickerpackendpoints which aren't supported for Cloud API.
- Changed
useCaseparameter type in the questionnaire endpointGET /v1/projects/{projectId}/rcs/questionnaire/{useCase}so that there isMULTIUSEvalue instead ofMULTI_USE.
- Added options for processing mode and retention policy for Conversation App.
2024-10-21
- Added countries query parameter to the questionnaire endpoint to include country specific questions to the response.
- Added an endpoint to fetch general questionnaire questions by use case.
- [
PROAPI-1908] - Setregionproperty of theconversationApiAppDetailsobject in sender endpoints response to Conversation API app region instead of the sender region. (|#1908)
2024-10-15
- Deprecated field
conversationApiAppfor sender endpoints.
- [
PROAPI-1801] - Added theconversationApiAppDetailsfield to sender endpoints, providing details of the Conversation API app connected to the sender. (|#1653)
2024-10-10
- Improvement of services
- Changed response for endpoint
POST /v1/projects/{projectId}/rcs/senders/{senderId}/testNumbersfrom array to object{ testNumbers: [] }.
- Fixed phone validation bug in sender update.
2024-10-07
- Improvement of services
- Provisioning API for
RCSservice is OpenBeta.
- Added new country status, which reflects the default state of a non-launched sender.
2024-09-25
- Added option to include strings in general questionnaire answers, which will be filtered out from data sent to Google. This allows for delimiters used by front-end.
- Added new type
UNIQUE_URLfor template analytics Button.
2024-09-23
- Added
RCS_ACCOUNT_COMMENT_ADDEDwebhook trigger. - Added
RCS_SENDER_COMMENT_ADDEDwebhook trigger. - Added
RCS_SENDER_STATUS_UPDATEDwebhook trigger.
- Fixed bug where additional emails, phones, and websites were ignored during sender updates.
- Added new value for
errorCodefor senderWABA_CONNECTED_TO_ANOTHER_PROJECT.
2024-09-16
- Improvement of services
2024-09-05
- Improvement of services
2024-09-04
- Improvement of services
- Provisioning API for
RCSservice is Closed Beta.
2024-09-02
- Improvement of services
2024-08-28
- Improvement of services
2024-08-26
- Improvement of services
2024-08-19
- Improvement of services
2024-08-12
- Improvement of services
2024-08-05
- [
PROAPI-951] - Added new optional fieldmessageSendTtlSecondsfor authentication template. (|#1461)
- Provisioning API for
Bundlesservice is GA.
- Provisioning API for
KakaoTalkservice is GA.
- [
PROAPI-1641] - RemovedUpdates a sender in projectendpoint. (|#1438)
2024-07-24
- [
PROAPI-1479] - Added optionalmetaLocalStorageproperties. If not provided metaLocalStorage will be automatically selected based on region. If not provided region will be automatically selected based on the country for billing address. (|#1402)
2024-07-19
- Improvement of services
2024-07-18
- Improvement of services
2024-07-15
- Removed the
Get a temporary URL for Facebook loginendpoint. Recent changes regarding the Embedded Signup flow for Meta has made the endpoint redundant. Please refer to the Getting started guide for Embedded Signup for an updated flow.
- Verify if Meta Template Analytics is enabled for the WhatsApp Business Account.
- Deprecated field
tpsPlanfor get sender endpoint.
- [
PROAPI-1573] - AddedmaxTpsfield to maximum tps, on get sender endpoint. (|#1401) - [
PROAPI-1456] - AddedwabaEnabledForInsightsfield to show status for Meta Template Analytics, on get account endpoint. (|#1389)
- Deprecated field
tpsPlanfor get sender endpoint. - Removed
Get a temporary URL for Facebook loginendpoint.
2024-07-08
- Improvement of services
2024-06-28
- Added
WHATSAPP_TEMPLATE_CATEGORY_UPDATEDwebhook trigger. - Added available value
REINSTATEDfor optionalnewStatefield for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATEDtype.
2024-06-24
- Added readonly field
compatibleRegionsto endpointsGet account for projectandGet sender for project. This field can be used to determine which Conversation API regions the sender is compatible with.
- Fixed bug sometimes showing wrong order of template components.
- Changed to optional
regionproperties in request body for endpoint:Create sender for project. If not provided region will be automatically selected based on the country for billing address.
2024-06-17
- Improvement of services
2024-06-10
- Improvement of services
2024-06-03
- Added trigger for conversation app:
MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION. - Added statuses for sms app:
PROVISIONING_ADD,PROVISIONING_UPDATE,PROVISIONING_ADD_FAILEDandPROVISIONING_UPDATE_FAILED.
- Added list sender categories endpoint.
- Deprecated
Get a temporary URL for Facebook loginendpoint. New Meta registration flow with solution id makes this endpoint redundant.
- Added optional
businessManagerproperties in request body for WhatsApp endpoints:List WhatsApp Business Accounts details,Create a long lived access token,Create account for project,Create sender for projectand query parameter forGet a temporary URL for Facebook login. If not provided businessManager will be automatically selected based on the country for billing address. - Added new value for
errorCodefor senderSENDER_HAS_BEEN_DELETED.
- Allow 2 URL Call To Action template buttons instead of 1.
- Add a constraint on template buttons to ensure that Quick Reply and Call To Action buttons are listed as 2 separate groups
- Increase number of supported template buttons from 3 to 10 in marketing template.
- Deprecated
Get a temporary URL for Facebook loginendpoint.
2024-05-30
- Reducing the size of the header example for image from 16MB to 5MB.
- Deprecated fields
wabaBanStateandwabaBanDatefor get sender endpoint. Get account endpoint should be used to get this information.
- Added
WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATEDwebhook trigger.
- Removed available value
REINSTATEDfor optionalnewStatefield for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATEDtype. - Align media header example file mime types and max sizes in accordance with the META documentation:
DOCUMENT- 100MB andtext/plain, application/pdf, application/vnd.ms-powerpoint, application/msword, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheetmime types,IMAGE5MB andimage/jpeg, image/png, image/webpmime types,VIDEO- 16MB andvideo/mp4, video/3gpmime types. - Deprecated fields
wabaBanStateandwabaBanDatefor get sender endpoint. Get account endpoint should be used to get this information.
2024-05-20
- Updated detecting mime type for file url.
- Added Template Analytics to the list templates and list templates by name endpoints.
- Added query parameter for template analytics date range to get template endpoint.
- Added Template Analytics to the update template endpoint.
2024-05-13
- Improvement of services
2024-05-06
- Added
KAKAOTALK_SENDER_COMMENT_ADDEDwebhook trigger. - Added
KAKAOTALK_SENDER_REJECTEDwebhook trigger.
2024-04-30
- Added
KAKAOTALK_SENDER_INACTIVEwebhook trigger.
- Added endpoint to enable Template Analytics.
2024-04-22
- Get number of times templates have been sent, delivered, read and clicked when using get template endpoint, based on Meta template analytics.
- Added field
previousPageTokento all list endpoints. - Added
qualityScoreproperty for templateQUALITY_SCORE_GREEN,QUALITY_SCORE_YELLOW,QUALITY_SCORE_RED,QUALITY_SCORE_UNKNOWNandUNRECOGNIZED. - Added
analyticsto get template endpoint.
- [
PROAPI-1274] - Removed optionalcloudApiflag from theCreate sender for projectrequest body when sender is of Embedded Signup type. A sender is now created as hosted in WhatsApp Cloud API by default. - Changed page max size to 1000 for endpoint
list all templates in project.
- Added field
previousPageTokento endpointlist all senders in project. - Added field
previousPageTokento endpointlist all categories in project. - Added field
previousPageTokento endpointslists activities on project templateandlists activities on sender. - Added field
previousPageTokento endpointlist all templates in project.
- Removed
KAKAOTALK_TEMPLATE_DELETEDwebhook trigger because it's redundant. - Changed page max size to 1000 for endpoint
list all templates in project.
- Added field
previousPageTokento endpointslist all senders in projectandlists activities on sender.
- Added field
previousPageTokento endpointlist all webhooks in project.
2024-04-15
- Fix validation for template
nameto 512 characters.
2024-04-08
- Improvement of services
2024-04-02
- Removed
v1alpha1andv1alpha2endpoints.
- Removed
businessManagerproperties from request body for WhatsApp endpoints:List WhatsApp Business Accounts details,Create a long lived access token,Create account for project,Create sender for projectand query parameter forGet a temporary URL for Facebook login. Currently, businessManager will be automatically selected based on the country for billing address. - Removed
regionfrom query parameter forGet a temporary URL for Facebook login.
- Added
KAKAOTALK_TEMPLATE_COMMENT_ADDEDwebhook trigger.
2024-03-25
- Improvement of services
2024-03-18
- Added
KAKAOTALK_TEMPLATE_DELETEDwebhook trigger. - Added
KAKAOTALK_TEMPLATE_REJECTEDwebhook trigger. - Added
KAKAOTALK_TEMPLATE_APPROVEDwebhook trigger.
2024-03-11
- Added optional properties if waba is banned;
wabaBanStateandwabaBanDate.
- Added optional properties if waba is banned -
wabaBanState-DISABLE / REINSTATE / SCHEDULE_FOR_DISABLE / UNRECOGNIZEDandwabaBanDate.
- Fixed
WHATSAPP_TEMPLATE_DELETEDwebhook trigger.
2024-03-04
- Added Brazil (
BR) region.
2024-02-26
- Improvement of services
2024-02-19
- Improvement of services
2024-02-12
- Improvement of services
2024-02-09
- Allowing
SINCH_UKbusiness manager to be used for cloud api senders in EU region.
- Allowing
SINCH_UKbusiness manager to be used for both cloud api senders in EU region.
2024-02-06
- Improvement of services
2024-02-01
- Provisioning API for
WhatsAppandWebhookservices is GA.
2024-01-31
- Fixed broken endpoint to update sender.
2024-01-22
- Added new endpoint to delete pending or rejected changes to a sender.
- Added endpoint to create sender comments.
- Added new endpoint to edit existing senders.
- Added endpoint to delete sender changes.
- Added endpoint to create sender comments.
- Added endpoint to update sender.
- Added
facebookCodefor create sender and create long lived access token. - Added new query parameter
typeto get login url endpoint. - Added optional
newStatefield for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATEDtype.
- Added
facebookCodeparameter to createSender endpoint. - Added
facebookCodeparameter to longLivedAccessToken endpoint. - Added parameter
type(ACCESS_TOKEN / CODE) to get login endpoint. Default value:ACCESS_TOKEN. This parametertypewill be removed 1st of February and response will be as for ype equalsCODE. - Added optional
newStatefield for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATEDtype. Available values:DISABLED,PAUSED,REINSTATEDandUNPAUSED.
- Fixed "List all stickerpacks for sender" endpoint,
pageTokenandpageSizeshouldn't be required parameters.
2023-12-21
- Improvement of services
2023-12-19
- Including
statusin body when creating a sender is optional. Logically it will default to submit if not provided.
- Creating senders without providing
statuswill default to submit.
- Added new endpoints to create, update, delete stickerpack.
- Added new endpoints to create, update, delete sticker.
- Including
statusin body when creating a template is optional. Logically it will default to submit if not provided. - Including
statusin body when creating a sender is optional. Logically it will default to submit if not provided. - Allowing Brazil business manager to be used for cloud api senders in BR region.
- Allowing Mexico business manager to be used for on premise and cloud api senders in BR region.
- Added stickerpack create endpoint.
- Added stickerpack update endpoint
- Added stickerpack delete endpoint.
- Added sticker create endpoint.
- Added sticker update endpoint
- Added sticker delete endpoint
- Added sticker index validation.
- Allowing Brazil and Mexico business manager to be used for both on premise and cloud api senders in BR region.
- Fixed validation for missing
exampleforHEADERandexamplesforBODYcomponents. - Creating templates without providing
statuswill default to submit. - Creating senders without providing
statuswill default to submit. - Improved parser for submit template errors from Meta.
- Fixed stickerpacks endpoints.
- Changed list stickers to return empty array instead of throw error.
- Including
statusin body when updating a template is optional. Logically it will default to draft if not provided. - Including
statusin body when creating a sender is optional. Logically it will default to submit if not provided. - Including
statusin body when creating a template is optional. Logically it will default to submit if not provided. - Added English names for template categories.
- Added field
nameEnglishto categoryDto and subcategoryDto for endpoint list of categories.
- Improved validation for methods create and update template with status
draft. - Improve validation of category code when creating new sender.
- Updating templates without providing
statuswill default to draft. - Creating senders without providing
statuswill default to submit. - Improved validation for create and update template endpoints.
- Creating templates without providing
statuswill default to submit. - Improved validation of name length when creating a new sender.
2023-11-20
- Changed create and update template endpoints which can return auto approved or auto rejected template after submit. If webhook is registered, it will be send.
2023-11-08
- Fixed
WHATSAPP_TEMPLATE_REJECTEDwebhook trigger.
2023-11-07
- With this release we have added the
v1endpoints. These are based on thev1alpha2endpoints and should therefore be an easy migration in that case.
- The
v1alpha1endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date. - The
v1alpha2endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date.
- Added v1 endpoints.
- The output for authentication templates is updated to not contain fields that are not valid for this category. Fields that have been removed are
textandexamplesin body and footer components. The change is only applied tov1alpha2andv1. - The previously deprecated field
v1payloadin WhatsApp webhooks have now been removed.
- Fixed
WHATSAPP_TEMPLATE_APPROVEDwebhook trigger. - Removed fields from output that are not valid for authentication templates.
- Default value for field
statusequalsSUBMITfor update sender endpoint. - Removed deprecated v1payload from webhooks.
- Improved errors for create template, when message footer format is incorrect.
- Improved errors for create template, when WhatsApp business account is restricted from creating new templates.
- Added new endpoint for update existing template.
- Added new endpoint to create sender.
- Added endpoint to update template.
- Added new endpoint to create sender.
- Fixed showing the change request status even if there are no changes requested.
2023-10-12
- Endpoints for retrieving WhatsApp sticker packs for a sender. Can be requested for different namespaces, WhatsApp (first-party) or user (third-party) maintained.
- When attempting to update a template in a non-updatable state, the error will correctly reflect this. Previously the same error was shown for non-updatable template state and non-updatable template draft status, providing an incorrect resolution.
- When attempting to update a template draft with a non-updatable status, the error will correctly reflect this. Previously the same error was shown for non-updatable template state and non-updatable template draft status, providing an incorrect resolution.
- Added optional query
namespaceto stickerpack endpoints.
- Split error for not updatable template into different errors depending on if it was caused by template in a non-updatable state, or template draft with a non-updatable status. (820)
2023-10-09
- Added new list endpoint for stickerpacks.
- Improved errors for create template for message body format incorrect.
2023-10-03
- Restore old template languages for v1alpha1.
- Fixed
WHATSAPP_TEMPLATE_DELETEDwebhook trigger.
2023-10-03
- Fixed issue where a template with a draft change with no changes was not showing up in changes field.
2023-10-02
- Added query parameters:
filterStatesandfilterStatusesfor senders and templates.
- When attempting to delete a change to a template, if no template draft can be found then the 404 error now explains that no pending changes for the template was found. Previously the error would claim that the template itself wasn't found.
- Removed query parameters:
sortColumn,sortDirection,templateStatusandsenderState. - Replaced values for
status-draft / submitbyDRAFT / SUBMIT. - Replaced values for enums to upper case.
- Added optional
saveDraftOnFailureflag to save obo sender if submission fails. Defaults to false. - Added query parameters:
filterStatesandfilterStatusesfor senders and templates. Can be given multiple enum values separated using comma. - Added optional
saveDraftOnFailureflag to save template if submission fails. Defaults to false. - Added endpoint to remove template from project.
- Remove query parameters:
sortColumn,sortDirection,templateStatusandsenderState. - Change values for
statusfield sender and template request toDRAFT / SUBMIT. - Change values for enums to upper case.
- Updated error message when no template draft was found when trying to remove.
- Added query parameters:
filterStatesandfilterStatusesfor senders and templates.
- When attempting to delete a change to a template, if no template draft can be found then the 404 error now explains that no pending changes for the template was found. Previously the error would claim that the template itself wasn't found.
- Changed default value for flag
saveDraftOnFailuretofalsein create template endpoint. - Removed query parameters:
sortColumn,sortDirection,templateStateandsenderState. - Replaced values for
status-draft / submitbyDRAFT / SUBMIT. - Replaced values for enums to upper case.
- Add
WHATSAPP_TEMPLATE_DELETEDwebhook trigger. - Added new compare templates endpoint.
- Added query parameters:
filterStatesandfilterStatusesfor senders and templates. Can be given multiple enum values separated using comma. - Added new get endpoint to retrieve list of stickers from a stickerpack for a sender.
- Added new get endpoint to retrieve sticker from a stickerpack for a sender.
- Fixed issue where a template with a draft change with no changes was not showing up in changes field.
- Updates WhatsApp sender description in details to 512 characters.
- Removed query parameters:
sortColumn,sortDirection,templateStateandsenderState. - Change values for
statusfield sender and template request toDRAFT / SUBMIT. - Change values for enums to upper case.
- Improved errors when creating templates.
- Updated error message when no template draft was found when trying to remove.
- Changed default value for optional flag
saveDraftOnFailuretofalsein create template endpoint.
- Added query parameters:
filterStatesandfilterStatusesfor senders and templates.
- Removed query parameters:
sortColumn,sortDirectionandsenderState. - Replaced values for
status-draft / submitbyDRAFT / SUBMIT. - Replaced values for enums to upper case.
- Added query parameters:
filterStatesandfilterStatusesfor sender. Can be given multiple enum values using comma.
- Removed query parameters:
sortColumn,sortDirectionandsenderState. - Change values for
statusfield sender request toDRAFT / SUBMIT. - Change values for enums to upper case.
2023-09-14
- Added endpoint to remove template drafts.
- Added Mexico business manager for US region.
- Allowing Brazil business manager to be used for on premise senders in BR region.
- Changed validation:
componentsare optional for template draft.
- Added
SINCH_MXbusiness manager for US region. - Allowing Brazil business manager to be used for on premise senders in BR region.
2023-09-11
- Added endpoint to get list of template activities.
- Added endpoint to create template comment.
- Fields
aboutandphotoUrlare made optional. - Added new values for sender tpsPlan -
XXLARGEandXXXLARGE.
- Changed
aboutandphotoUrlfor sender properties to optional.
- Added new get endpoint to retrieve stickerpack for a sender.
- Added new values for sender tpsPlan -
XXLARGEandXXXLARGE.
2023-08-28
- Added new status
DISABLEDfor templates. Allow editingDISABLEDstatus.
- Added endpoint to get list of categories for template.
2023-08-07
- Improvement of services
2023-07-10
- 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
valuefor buttons components in templates. - Fixed deletion of edited templates in APPROVED or PAUSED statuses.
- Added endpoint to create KakaoTalk templates.
- Changed inverted dimensions for rcs sender banner - height
448 pxand width1440 px.
2023-06-28
- Fixed file uploading for update template.
2023-06-21
- Corrected the response for the edited sender.
2023-06-19
- Added version 2 for templates.
- Added Message Template header type
LOCATION.
- A telegram channel with no followers unexpectedly threw an error. It now correctly returns
0followers.
2023-06-01
- Fixed deleting templates for
IN_PROGRESSstate.
2023-05-26
- Rename
errorMessagetorejectionCodein template.
- Renamed
errorMessagetorejectionCodein template.
2023-05-26
- Add new fields for authentication template.
- Add
errorMessagefield if template is rejected. - Allow editing
APPROVEDandPAUSEDtemplate.
- Added otp button.
- Added new field
codeExpirationMinutesin footer component dto. - Added
errorMessagefield to template. Possible values:ABUSIVE_CONTENT,INCORRECT_CATEGORY,INVALID_FORMAT,NONE,SCAM,UNRECOGNIZED. The field is only populated ifstatusisREJECTEDand contains the rejection reason from Meta. - Added new field
addSecurityRecommendationin body component dto. - Allow editing
APPROVEDandPAUSEDtemplates.
textproperty for body and footer component are optional because ofAUTHENTICATIONcategory.
2023-05-25
- For error bad request error (400,
invalid_input) texts invalidationErrorsare changed. These should not be used for validation errors to the end user and are primarily intended to be used for debugging.
- Updated validation errors message to fix some grammatical errors. All enum fields will now specify which enums are valid.
- Add new field to template
allowCategoryChangewhich is allowing Meta to change the template category
- Added optional
allowCategoryChangefield to template creation. - Added optional
wabaIdfor account endpoints responses.
- Removed
ML_INTENT_SENTIMENT_ANALYSISfrom conversation webhooks triggers. - Removed
UNSPECIFIED_TRIGGERandUNRECOGNIZEDfrom input bundles conversation webhooks triggers.
2023-05-16
- Added new field
errorCodefor sender. Possible values:NOVA_ACCOUNT_ID_CONFLICTNO_NOVA_ACCOUNT_IDPROJECT_ID_CONFLICTNO_PROJECT_IDCANNOT_ASSIGN_CREDIT_LINECANNOT_SUBSCRIBE_TO_WEBHOOKNO_PRICING_PLANCANNOT_ASSIGN_SYSTEM_USERNO_VERIFIED_PHONE_NUMBERCANNOT_GET_WABA_DETAILSMULTIPLE_WABA_FOR_PROJECT_IDNOT_VERIFY_BUSINESS_VIA_WHATSAPPCANNOT_CREATE_NEW_WHATSAPP_BOTCANNOT_REGISTER_NEW_WHATSAPP_BOTFAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATESNOT_VERIFIED_REQUESTED_PHONE_NUMBERDUPLICATES_ON_SENDER_PHONE_NUMBERCANNOT_CREATE_WABA_FOR_BUSINESSCANNOT_SUBSCRIBE_TO_CLOUD_APICANNOT_GET_DETAILS_FOR_CLOUD_APICANNOT_REGISTER_TO_CLOUD_APIUNKNOWN_ERRORNO_CERTIFICATE_AVAILABLEUNRECOGNIZEDerrorReasonreturns a string with error details
2023-04-26
- Add
textproperty for buttons components which replacesvalueproperty.textshould be used.valuewill be removed June 1, 2023.
- The
statefield for account is returned only if the account is created. - Available
statevalues for account -ONBOARDED,PENDING_FACEBOOK_VERIFICATION,REJECTED.
- Remove
NOT_REGISTEREDandREQUESTforstatein account response. Available only:ONBOARDED,PENDING_FACEBOOK_VERIFICATION,REJECTED. statefor get account is optional.- Add
textproperty for buttons components which replacesvalueproperty.valueis deprecated and will be removed in a future update
2023-04-05
- Add
WHATSAPP_SENDER_DAILY_LIMIT_CHANGED,WHATSAPP_SENDER_QUALITY_RATING_CHANGEDandWHATSAPP_TEMPLATE_STATUS_UPDATEDwebhook trigger.
- Fixed missing
createdandmodifieddate for template.
2023-03-27
- Only new template categories allowed:
AUTHENTICATION,MARKETINGandUTILITYfrom April 3, 2023
- Added new template categories
AUTHENTICATION,UTILITY. - Added new template status
PAUSED.
- Improve errors for create long lived access token endpoint.
2023-03-13
- Added list endpoint for sender.
- Added get endpoint for sender.
- Added endpoint to get and list templates.
- Renamed
facebookManagerIdtoclientBusinessManagerId - Only new template categories allowed:
TRANSACTIONAL,MARKETINGandOTP - Removed endpoint to list account, sender and template activity (
*/activity)
- Added endpoint to list account, sender and template activities (
*/activities).
- Improve errors for list WABA and create long lived access token endpoint.
- Rename
facebookManagerIdtoclientBusinessManagerId. - Allow new template categories when creating templates:
TRANSACTIONAL,MARKETINGandOTP. - Removed endpoint to list account, sender and template activity (
*/activity). */activityendpoints are deprecated.
2023-02-28
- Added current
statefield for bundle response.
- Fixed triggering webhook if conversation app had set sms credentials.
2023-02-08
- Additional validation of the phoneNumberId used to create the ES.
- Improve errors for list WABA and create long lived access token endpoint.
2023-02-07
- Added capability to specify which Facebook Business Manager to use when getting temporary login url.
- Improved returned errors for endpoints: create a long lived access token and list WhatsApp Business Accounts details.
- Added optional
businessManagerto get temporary URL for Facebook login.
2023-01-31
- Added capability to specify which Facebook Business Manager to use when creating an account or sender.
- Added optional
businessManagerto Account and Embedded Signup Sender creation.
- Fixed webhook for
WHATSAPP_TEMPLATE_COMMENT_ADDED. - Fixed webhook for
WHATSAPP_ACCOUNT_COMMENT_ADDED. - Fixed fetching template / senders.
- Change the following trigger values:
RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED->RCS_SENDER_COMMENT_ADDEDRCS_SENDER_CHANGE_REQUEST_REJECTED->RCS_SENDER_REJECTEDRCS_SENDER_CHANGE_REQUEST_DONE->RCS_SENDER_CREATED
- Added validation for sender.
- Change values for webhook trigger:
RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED->RCS_SENDER_COMMENT_ADDED,RCS_SENDER_CHANGE_REQUEST_REJECTED->RCS_SENDER_REJECTEDandRCS_SENDER_CHANGE_REQUEST_DONE->RCS_SENDER_CREATED.
- Added optional
commentfield for webhook payload.
- Add values for
commentfield for webhook payload.
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.
- Update all channel endpoints to contain Conversation API channel status. Unless the status is ACTIVE, the channel information will not be displayed.
2023-01-16
- Added filtering and sorting for list senders.
- Added returned values for
qualityRatinganddailyLimit.
- Changed response http code to
201for:- create login
- create template
- If no list activity for sender / template /account it will be return empty array. Previous it was returned
404error.
- Add values for
qualityRating:GREEN,RED,YELLOWand fordailyLimit:NOT_SET,TIER_50,TIER_250,TIER_1K,TIER_10K,TIER_100K,TIER_UNLIMITED. - Add query options for listSenders - filter by
senderState, sort byname,state,created,modifiedand sort directionascanddesc.
- Fixed returning
changesafter sender update. - Fixed returning
createdandmodifieddates for sender. - Change http status code to
201for WhatsApp create login endpoint and create template endpoint. - Fixed filtering by
templateStatus. - Changed fit if
photoUrlfor sender image is too big tocover. - 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.
Instagram channel information has changed to show new values. Previous implementation erroneously showed the same information as Facebook Messenger senders.
- Updated Instagram channel information endpoint to show real Instagram values.
- Added filtering and sorting for list senders.
- Added list of supported countries for suppliers.
- Added endpoints:
- create sender comment.
- list sender activity.
- Add query options for listSenders - filter by
senderState, sort bynamestate,created,modifiedand sort directionascanddesc. - 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.
- Fixed returning
createdandmodifieddates for sender. - Return empty array of notifications for list activity if no exist.
- Fixed get sender and list senders - filter by
projectId.
- Changed response http code to
201for create bundles.
- Change http status code to
201for bundles create endpoint.
- Changed response http code to
201for create webhooks.
- Change http status code to
201for webhooks create endpoint.
2022-12-20
- Added
isEmbeddedSignupfor Account response. Based on this value, it can be determined whether the account was created using Embedded Signup or On Behalf of.
- Increased the allowed length for sender
aboutfield from 128 to 139 characters.
2022-12-13
- Added
x-b3-traceidin 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/jsonand body witherrorCode,message,resolution.
- Added
x-b3-traceidin headers if request is proxying to microservices.
- Changed all error responses to JSON Error format.
- This release adds the possibility to create an Embedded Signup sender which will be hosted on the WhatsApp Cloud API from creation.
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
conversationApiEnabledas it now will always betrue. - Removed
callbackUrlas the callback will be set internally though Conversaiton API.
- Removed
Create comment endpoint for all resources have the fields
id,modified,userremoved. The response will now be the same format as the list activities endpoints.
- Added an optional flag to set up the sender for cloud api if it's embedded signup.
- Removed
id,modified,userfrom create comment response. - Removed flag
conversationApiEnabledwhen creating sender. - Fixing listSenders endpoint - adding missing internal pagination.
- Removed sender
callbackUrlfor OBO sender. Changed sender details. - Limited sender state for update sender has to be update.
- Until Sender is not
ACTIVEshowing data inchanges. - 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 is currently in active development. This release contains pre-release functionality and can be requested to trial it.
- Added endpoint to list senders.
- Added endpoint to creating sender.
- Added endpoint to fetching sender.
2022-11-14
- Template have one breaking changes:
whatsappIdfield would previously return an empty string if not set. Field will now not be set.
- Hide
whatsappIdif there is no value. - Update documentation to clarify which regions are supported for senders.
- Fixed remove sender photo url.
- Fixed sender
callbackUrlfor OBO sender ifconversationApiEnabledequalsfalse.
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 endpoint to query Instagram channel information for a Conversation Api App.
- Added endpoint to query Facebook Messenger channel information for a Conversation Api App.
2022-11-09
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.
- Activity lists for all resource types have the following changes:
- Updated
typefield enum to reflect the status of the resource type. - Removed
createdByandmodifiedByfields. These fields referenced internal users not usable by an API user. - Removed
descriptionandtitlefields from activity list. These fields contained parsed english strings. Users should use thetypefields.
- Updated
- Sender details have the following breaking changes:
- Region enum values has changes. Previous enum listed values as
EUROPE,AMERICA,ASIA,AUSTRALIAandSOUTH_AMERICA. New values are respectivelyEU,US,AS,AUandSA. OnlyEUandUSare currently supported for creating senders. - Number provider type has moved from
details.numberProvidertonumberProviderin 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.
- Region enum values has changes. Previous enum listed values as
- Webhook triggers:
- Previously a trigger
WHATSAPP_TEMPLATE_IN_PROGRESSexisted in the allowed webhook triggers. This trigger has been removed as the In Progress state is a user initiated transition. - Webhook trigger
WHATSAPP_TEMPLATE_DELETEDdid not work as intended. It has been removed temporarily and will be added in a future version when fully working.
- Previously a trigger
- Added sender
callbackUrlfor OBO sender. Changed sender details. - Add flag
conversationApiEnabledwhen creating a OBO sender. - Add optional
saveDraftOnFailureflag 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
errorfield containing reason for error if sender is in stateERROR. - Add
commentfield to activity lists. - Add update sender endpoint.
- Add endpoint to start verification register for OBO sender.
- Add
WHATSAPP_TEMPLATE_COMMENT_ADDEDwebhook trigger. - Add creating and listing comments for account.
- 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_DELETEDwebhook trigger. - Fixed validation for components
BUTTONS- require at least one character forvalue. - 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
typefield 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
DRAFTbefore updating if the change request isREJECTED. - 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
createdByandmodifiedByfields from activity lists. - Fix validation for OBO sender verification erroneously allowing empty verification code.
- Remove
WHATSAPP_TEMPLATE_IN_PROGRESSwebhook trigger.
- Previous version allowed to register a webhook trigger with both
ALLand a specific triggers such asWHATSAPP_TEMPLATE_APPROVED. Now onlyALLis allowed if specified and if any more are provided an error is thrown.
- Renaming
Update WebhooktoReplace Webhook(PUTmethod) and addingUpdate Webhook(PATCHmethod). - Do not allow other triggers along with
ALL.
- Retry if Conversation API returns an error when setting App credentials.