# Provisioning API Release Notes See how the Provisioning API is evolving and find out about new features and bug fixes. # 1.2.87 2026-07-10 ## WhatsApp ### Changed - Improved filtering of deleted senders. # 1.2.86 2026-07-06 ## WhatsApp ### Added - Added support for Uruguay ES_UY for template. ## RCS ### Changed - Allow unlaunching a sender by clearing its countries list and calling launch endpoint. # 1.2.85 2026-07-06 ## WhatsApp ### Added - Added a new payload for creating a sender with a phone number attached. - Added `WHATSAPP_SENDER_USERNAME_UPDATED` webhook trigger for WhatsApp sender username update events. ### Removed - WhatsApp Onboarding using 'On Behalf Of' is no longer available # 1.2.84 2026-06-29 ## RCS ### Added - Added `brandId` for google `supplierDetails`. ## WhatsApp ### Added - Added `REQUEST_CONTACT_INFO` button type for buttons component. # 1.2.83 2026-06-25 ## Common - Improvement of services # 1.2.82 2026-06-22 ## Common - Improvement of services # 1.2.81 2026-06-22 ## WhatsApp ### Added - Added optional `username` field to sender update input. ### Changed - Deprecated `partnerInitiatedRequestId` in WhatsApp account responses. # 1.2.80 2026-06-19 ## Upscale ### Changed - Improve filtering for SMS Apps for upscale. # 1.2.79 2026-06-15 ## RCS ### Added - Enabled `KPN Netherlands` operator. # 1.2.78 2026-06-08 ## WhatsApp ### Added - Added `preferredCurrency` field to sender creation flow. - Added `NOT_SET` as a supported value for the WhatsApp sender details `vertical` field. # 1.2.77 2026-06-01 ## Common - Improvement of services ## WhatsApp ### Added - Added `preferredCurrency` field to account creation flow. ## RCS ### Changed - Accept brand color aspect ratios equal to 4.5 # 1.2.76 2026-05-28 ## Common - Improvement of services # 1.2.75 2026-05-26 ## Common - Improvement of services # 1.2.74 2026-05-25 ## Common - Improvement of services # 1.2.73 2026-05-25 ## WhatsApp ### Changed - Lift the restriction on the urls `facebook.com`, `fbcdn.net`, `instagram.com`, `tfbnw.net` in templates # 1.2.72 2026-05-18 ## Common ### Added - Added `x-w3c-traceid` to response headers # 1.2.71 2026-05-18 ## WhatsApp ### Added - Added an admin endpoint for account deletion # 1.2.70 2026-05-13 ## Common - Improvement of services # 1.2.69 2026-05-13 ## Common - Improvement of services # 1.2.68 2026-05-12 ## RCS ### Added - Added `addressCountry` property to the US sender questionnaire answers. ### Changed - Updated the `brandIndustry` property in the US sender questionnaire answers to use an enum type. - Updated the `legalForm` property enum values in the US sender questionnaire answers to: `Corporation` ,`Limited Liability Corporation (LLC)`, `Partnership`, `S Corporation`, and `Sole Proprietorship`. # 1.2.67 2026-05-11 ## SMS ### Added - Added `convApiAppId` to SMS App create request to link an existing Conversation API App during creation. - Added `convApiApp` to SMS App create request to optionally create a new Conversation App # 1.2.66 2026-05-07 ## Common - Improvement of services # 1.2.65 2026-05-07 ## Common - Improvement of services # 1.2.64 2026-05-06 ## RCS ### Changed - Fixed sender listing with offset and limit greater than 25. # 1.2.63 2026-05-06 ## Common - Improvement of services # 1.2.62 2026-05-05 ## Common - Improvement of services # 1.2.61 2026-04-30 ## WhatsApp ### Deprecated - Deprecated `dailyLimit` property for sender dto. Use `businessDailyLimit` property for account dto instead. - Deprecated `WHATSAPP_SENDER_DAILY_LIMIT_CHANGED` webhook. Use `WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED` instead. ### Added - Added `WHATSAPP_SENDER_DELETED` webhook trigger for event emitted when a WhatsApp sender is deleted. - Added `businessDailyLimit` property for account dto. - Added `WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED` webhook trigger for business daily limit changes for account. ### Changed - Added username field to sender responses . - add `currency` field to whatsapp account dto - Removed business type restriction for partner-initiated accounts and senders. Direct Business accounts can now create partner-initiated accounts and senders. ## RCS ### Deprecated - Deprecated `fullCompanyAddress` and `fullCompanyAddressMetadata` properties for US sender details questionnaire answers. Use `addressLine1`, `addressLine2`, `addressCity`, `addressState`, and `addressPostalCode` instead. ### Added - Enabled `Sasktel` operator. - Enabled `DISH Wireless` operator. - Added `addressLine1`, `addressLine2`, `addressCity`, `addressState`, and `addressPostalCode` properties to US sender details questionnaire answers. # 1.2.60 2026-04-23 ## Common - Improvement of services # 1.2.59 2026-04-23 ## Common - Improvement of services # 1.2.58 2026-04-22 ## Common - Improvement of services # 1.2.57 2026-04-22 ## Common - Improvement of services # 1.2.56 2026-04-20 ## Common - Improvement of services # 1.2.55 2026-04-17 ## Common - Improvement of services ## WhatsApp ### Added - Added an endpoint to synchronize templates. # 1.2.54 2026-04-15 ## Common - Improvement of services # 1.2.53 2026-04-13 ## Common - Improvement of services # 1.2.52 2026-04-13 ## RCS ### Added - Enabled `1und1 Germany` operator. ### Deprecated - Disabled `US Cellular` operator in `US`. # 1.2.51 2026-04-13 ## Common - Improvement of services # 1.2.50 2026-04-13 ## Common - Improvement of services # 1.2.49 2026-04-09 ## Common - Improvement of services # 1.2.48 2026-04-09 ## Common - Improvement of services # 1.2.47 2026-04-09 ## Common - Improvement of services # 1.2.46 2026-04-08 ## Common - Improvement of services # 1.2.45 2026-04-07 ## Bundles ### Deprecated - Deprecate `test` property for `smsApp` object. The flag is ignored and the selection is based on the client type. ## SMS ### Deprecated - Deprecate `test` property. The flag is ignored and the selection is based on the client type. # 1.2.44 2026-04-02 ## Common - Improvement of services # 1.2.43 2026-04-02 ## Common - Improvement of services # 1.2.42 2026-04-02 ## Bundles - Added the `smsChannelStatus` field into `convApp` providing status of the Conversation API app connected to the sender. ## SMS - Added the `channelStatus` field into `conversationApiAppDetails` providing status of the Conversation API app connected to the sender. ## RCS - Added the `channelStatus` field into `conversationApiAppDetails` providing status of the Conversation API app connected to the sender. - Removed the Spain-specific (`es`) sender launch questionnaire from RCS sender questionnaire. ## WhatsApp - Added the `channelStatus` field into `conversationApiAppDetails` providing status of the Conversation API app connected to the sender. # 1.2.41 2026-03-30 ## Common - Improvement of services # 1.2.40 2026-03-30 ## Common - Improvement of services # 1.2.39 ## RCS ### Changed - Allow unsetting sender brand websites, emails and/or phone numbers. 2026-03-26 ## Common - Improvement of services # 1.2.38 2026-03-27 ## Bundles ### Changed - Added a `test` for SMS app in create bundles request. It is responsible for creating a Test SMS App. # 1.2.37 2026-03-26 ## Common - Improvement of services # 1.2.36 2026-03-24 ## Common - Improvement of services # 1.2.35 2026-03-24 ## Common - Improvement of services # 1.2.34 2026-03-23 ## Common - Improvement of services # 1.2.33 2026-03-23 ## Bundles ### Changed - Added a `regions` property to `smsApp` object. ## RCS ### Added - Enabled Greece as a supported country. - Enabled Hungary as a supported country. - Enabled `Hungary Telekom` operator. - Enabled `Cosmote Greece` operator. # 1.2.32 2026-03-19 ## Bundles ### Added - Added optional `targetType` support for Conversation App webhooks in Bundles. # 1.2.31 2026-03-16 ## Common - Improvement of services # 1.2.30 ## RCS ### Breaking changes - Renamed `description` field to `useCaseDescription` in the list of US-specific questions in the senders endpoints response. ### Added - Added `search` query parameter to sender list endpoints for filtering senders. Supports partial matching and is case-insensitive. - Added `useCaseDescription` field to the list of US-specific questions in the senders endpoints response. - Added `contactEmail` field to the list of US-specific questions in the senders endpoints response. ### Changed - Removed `description` field from the list of US-specific questions in the senders endpoints response. ### Deprecated - The `filterSenderName` query parameter is deprecated in favor of the new `search` parameter. # 1.2.29 2026-03-05 ## WhatsApp ### New features - Added new endpoint for deleting an account. ### Added - Add value for `dailyLimit`: `TIER_2K`. - Added endpoint to delete account. Deleting an account is only possible if there is no sender assigned to the account. ## RCS ### Breaking changes - Removed deprecated FR questions. ### Changed - Removed deprecated FR questions. # 1.2.28 2026-03-02 ## Common - Improvement of services ## RCS ### Added - Enabled Peru as a supported country as well as `Peru Entel` operator. - Added extended US questionnaire. # 1.2.27 2026-02-23 ## Common - Improvement of services # 1.2.26 2026-02-16 ## Common - Improvement of services # 1.2.25 2026-02-11 ## Common - Improvement of services # 1.2.24 2026-02-09 ## RCS ### Breaking changes - Added mapping billing categories: - `BASIC_MESSAGE` to `NON_CONVERSATIONAL` - `SINGLE_MESSAGE` to `NON_CONVERSATIONAL` - `CONVERSATIONAL_LEGACY` to `CONVERSATIONAL` ### Added - According to changes at Google added mapping for billing categories: `BASIC_MESSAGE` to `NON_CONVERSATIONAL, `SINGLE_MESSAGE`to`NON_CONVERSATIONAL`and`CONVERSATIONAL_LEGACY`to`CONVERSATIONAL`. ## Common ### Changed - Accepting more than 20 values ​​for one query parameters. ## WhatsApp ### Changed - Accepting more than 20 values ​​for `fieldMask` query parameter. # 1.2.23 2026-02-02 ## RCS ### New features - Added new `NON_CONVERSATIONAL` billing category. Use `NON_CONVERSATIONAL` instead of deprecated values `BASIC_MESSAGE` and `SINGLE_MESSAGE`. Use `CONVERSATIONAL` instead of deprecated value `CONVERSATIONAL_LEGACY`. ### Added - Added new `NON_CONVERSATIONAL` billing category. ### Deprecated - Deprecated `BASIC_MESSAGE`, `CONVERSATIONAL_LEGACY`, and `SINGLE_MESSAGE` billing category values. ## WhatsApp ### Changed - Added possibility to use any kind of sender input Dto in both embedded or not embedded WhatsApp accounts. # 1.2.22 2026-01-26 ## WhatsApp ### Changed - Set the `code` parameter to optional in the request body for the sender verification endpoint. ## Bundles ## Breaking Changes - Removed `accessTokens` from smsApp. ### Changed - Removed `accessTokens` from smsApp. # 1.2.21 2026-01-19 ## Common - Improvement of services # 1.2.20 2026-01-12 ## Common - Improvement of services # 1.2.19 2025-12-23 ## Common - Improvement of services # 1.2.18 2025-12-19 ## Common - Improvement of services # 1.2.17 2025-12-18 ## RCS ### Changed - Disabled `1&1 Germany` operator. # 1.2.16 2025-12-10 ## WhatsApp ### New features - Added support for Meta Partner-initiated sender creation in account update endpoint. ### Changed - Fixed embedded sender creation when onboarded for other channel - Added support for creating partner-initiated senders. ## Bundles ### Added - Added an optional `convApp.consentManagerSettings` field to both the create bundle request and the get bundle response. ## RCS ### Added - Enabled `Elisa Finland` operator. ### Changed - Added opportunity to actually delete a test number from a RCS sender. - Disabled `Tracfone` and `Spectrum` operators in US. # 1.2.15 2025-11-18 ## Common - Improvement of services # 1.2.14 2025-11-17 ## WhatsApp ### Changed - Fixed accessibility of uploaded files when submitting template.. # 1.2.13 2025-11-06 ## WhatsApp ### New features - Added support for Meta Partner-Initiated Business Accounts in account update endpoint. ### Changed - Added partner-initiated waba support for update account endpoint. # 1.2.12 2025-11-03 ## Common - Improvement of services # 1.2.11 2025-10-27 ## Bundles ### Deprecated - Deprecated `accessTokens` from smsApp. Field will be removed from response by end of October. ### Breaking Changes - Changed logic of creation a sms app. Now it could be created only with a conversation app. # 1.2.10 2025-10-23 ## WhatsApp ### New features - Verify if Meta Direct Send API is enabled for the WhatsApp Business Account. ### Added - Disallow updating of templates generated by Meta. - Added `isMetaGenerated` field to template endpoints response to indicate whether the template was generated by Meta. - Added `wabaEnabledForDirectSend` field to account endpoint response to indicate whether the account has Meta Direct Send API enabled. ### Changed - Changed endpoints to manage Meta Multi-Partner Solutions to GA - Fixed `required` and `not required for draft` marks for template flow button fields in public documentation. # 1.2.9 2025-10-20 ## RCS ### Added - Enabled `Proximus BE` operator. ## WhatsApp ### Changed - Added failed solutions to create solution response. # 1.2.8 2025-10-13 ## WhatsApp ### New features - Added support for Meta Partner-Initiated Business Accounts in account creation endpoint. ### Added - Added partner-initiated waba support for create account endpoint. ## RCS ### Changed - Set `companyLegalName`, `companyRegistrationNumber` and `fullCompanyAddress` as required for country specific questions for United Kingdom of Great Britain. - Enabled `AT&T` operator in US. # 1.2.7 2025-10-06 ## Common - Improvement of services # 1.2.6 2025-10-02 ## Common - Improvement of services # 1.2.5 2025-10-02 ## Common - Improvement of services # 1.2.4 2025-09-29 ## Common - Improvement of services # 1.2.3 2025-09-22 ## RCS ### Added - Added Finland as supported country. - Added new field `launched` to sender. # 1.2.2 2025-09-15 ## WhatsApp ### New features - Added list flow ids endpoint. ### Breaking changes - Changed type for id of the solution to `string`. ### Added - List flow ids endpoint added. ### Changed - Change type for id ot the solution to `string`. ## RCS ### Changed - Enabled `DNA Finland` operator in FI. - Enabled `O2` operator in CZ. # 1.2.1 2025-09-08 ## Common - Improvement of services # 1.2.0 2025-09-01 ## WhatsApp ### New features - Added new endpoint to create Multi-Partner Solution as Open Beta. - Added new endpoint to get Multi-Partner Solution as Open Beta. - Added new endpoint to list Multi-Partner Solutions as Open Beta. - Added new endpoint to assign Multi-Partner Solution to project as Open Beta. ### Added - Added endpoints to manage Meta Multi-Partner Solutions, as Open Beta ## RCS ### Changed - Enable `US Cellular` operator in US. # 1.1.22 2025-08-27 ## Common - Improvement of services # 1.1.21 2025-08-27 ## Common - Improvement of services # 1.1.20 2025-08-25 ## Common - Improvement of services # 1.1.19 2025-08-19 ## WhatsApp ### New features - Template button of type `FLOW` added. ### Added - Template button of type `FLOW` added. - Added field `authenticationCode` for Embedded Signup Sender # 1.1.18 2025-08-14 ## RCS ### Breaking Changes - Removed `UNRECOGNIZED` for `filterStates`. ### Updated - Updated `filterStates` - not accept `UNRECOGNIZED` value. # 1.1.17 2025-08-12 ## WhatsApp ### Added - Added support of Zero-Tap Otp buttons for Authentication templates. # 1.1.16 2025-08-05 ## Common - Improvement of services # 1.1.15 2025-08-04 ## RCS ### Breaking Changes - New properties for country specific questions for United Kingdom of Great Britain will be required for launch by end of September: `companyLegalName`, `companyRegistrationNumber` and `fullCompanyAddress`. ### Changed - Added `companyLegalName`, `companyRegistrationNumber` and `fullCompanyAddress` to country specific questions for United Kingdom of Great Britain. These fields will be required for launch by end of September. Additionally added optional property `fullCompanyAddressMetadata`, which can be used for customization of frontend. # 1.1.14 2025-07-29 ## Common - Improvement of services # 1.1.13 2025-07-28 ## RCS ### Deprecated - Deprecated `campaignLength` from country specific questions, for United Kingdom of Great Britain. This field is no longer required. ### Changed - Deprecated `campaignLength` from country specific questions, for United Kingdom of Great Britain. This field is no longer required, if provided the field will be ignored. Field will be removed from response by end of August. # 1.1.12 2025-07-22 ## Conversation ### Deprecated - The webhook triggers `BILLING_CREDIT_LIMIT_BREACHED` and `CONSENT_BATCH_COMPLETE` are now deprecated and will be in a future version. ### Added - Added new webhook trigger `BATCH_STATUS_UPDATE`. ### Changed - Deprecated webhook triggers `BILLING_CREDIT_LIMIT_BREACHED` and `CONSENT_BATCH_COMPLETE`. ## Webhook ### Deprecated - The webhook triggers `BILLING_CREDIT_LIMIT_BREACHED` and `CONSENT_BATCH_COMPLETE` are now deprecated and will be in a future version. ## Bundles ### Deprecated - The webhook triggers `BILLING_CREDIT_LIMIT_BREACHED` and `CONSENT_BATCH_COMPLETE` are now deprecated and will be in a future version. ## RCS ## Changed - Enable Odido operator in NL for RCS launch. # 1.1.11 2025-07-14 ## Common - Improvement of services # 1.1.10 2025-07-07 ## Common - Improvement of services # 1.1.9 2025-07-03 ## Bundles ### Changed - Updated error for incorrectly formatted bundleId. ## KakaoTalk ### Added - Relax validation for creating and updating draft senders ## RCS ### Changed - US country specific questions will not be forced yet when launching a Sender. However it will eventually be enforced for launch of a Sender. ## Webhook ### Changed - Updated error for incorrectly formatted webhookId. # 1.1.8 2025-06-30 ## RCS ### Changed - Deprecated `usersAmount` and `startDate` from 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 - Added US country specific questions, that are required for launch in US. # 1.1.7 2025-06-23 ## Common - Improvement of services # 1.1.6 2025-06-16 ## RCS ### New features - `filterCountries` and `filterBillingCategories` added for admin "list senders" endpoint. ### Added - Add country and billing category filter to admin list senders ### Updated - Improved resolution in error message, when trying to launch sender in invalid state. # 1.1.5 2025-06-05 ## Common - Improvement of services # 1.1.4 2025-06-03 ## Bundles ### Added - Added new triggers `BILLING_CREDIT_LIMIT_BREACHED` and `CONSENT_BATCH_COMPLETE` for conversation webhooks. ## KakaoTalk ### New features - Added update sender endpoint. ### Added - Restored update sender endpoint # 1.1.3-rc2 2025-06-02 ## Common - Improvement of services # 1.1.3 2025-06-02 ## RCS ### Added - Enabled Telia Norway. # 1.1.2 2025-05-26 ## RCS ### Added - Added Google agentId to senderDto. # 1.1.1 2025-05-20 ## Common - Improvement of services # 1.1.0 2025-05-19 ## WhatsApp ### Added - Adding ability to delete submitted templates by name ## KakaoTalk ### New features - Added new endpoint to delete Sender. ### Added - Added delete sender endpoint ## RCS ### Added - Added Poland as supported country. - Added unformatted phone number as an option to e.164 format for brand phone numbers. # 1.0.118 2025-05-12 ## RCS ### Changed - Added SIREN as country specific question for France. # 1.0.117 2025-05-07 ## Bundles ### Changed - Changed default value for `convApp.processingMode` to `DISPATCH`. Please review your configurations and update any dependencies accordingly. # 1.0.116 2025-05-05 ## WhatsApp ### Deprecated - Deprecated On-Behalf-Of (OBO) Sender creation, since Meta has announced End-Of-Life (EOL) in September 2025. ### Changed - Deprecated OBO Sender DTO. # 1.0.115 2025-04-28 ## Common - Improvement of services # 1.0.114 2025-04-22 ## Bundles ### Added - Added id to bundle's subproject return data ## RCS ### Added - Added Norway to the list of sender countries. # 1.0.113 2025-04-15 ## Common - Improvement of services # 1.0.112 2025-03-31 ## Whatsapp ### Deprecated - Deprecated field `conversationApiApp` for sender endpoints. ### Added - Added the `conversationApiAppDetails` field to sender endpoints, providing details of the Conversation API app connected to the sender. ## RCS ### Added - Enabled `Telenor Norway` operator. - Enabled `1und1 Germany` operator. - Enabled `Telenor Sweden` operator. # 1.0.111 2025-03-24 ### New features - Added `CAROUSEL` component for Message Template. ## WhatsApp ### Added - Added `CAROUSEL` component for Message Template. # 1.0.110 2025-03-17 ## RCS ### Changed - Fixed a bug that prevented validation of some toll free international numbers. # 1.0.109 2025-03-13 ## RCS - Provisioning API for `RCS` service is GA. ### Deprecated - Deprecated field `callbackUrl` in sender response. - Removed field `callbackUrl` from sender input. It will be ignored, so it's not breaking. ### Changed - Fix validation for websites `url` to 255 characters. - Deprecated `callbackUrl` in 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. ## Whatsapp ### Deprecated - Deprecated `Create a long lived access token` endpoint. - Deprecated `List WhatsApp Business Accounts details` endpoint. - Deprecated request body for creating Embedded Sender. ### New features - Added new request body for creating Embedded Sender. ### Added - Added `fieldMask` query parameter to get and list template endpoints. Field masks are a way for API callers to list the fields that a request should return. - Added new required body for creating Embedded Sender where `wabaId` and `phoneNumberId` are required. - Added sender `vertical` - `ALCOHOL` , `ONLINE_GAMBLING`, `OTC_DRUGS` and `PHYSICAL_GAMBLING`. ### Changed - Deprecated request body for creating Embedded Sender where `facebookAccessToken` or `facebookCode` were required. - Deprecated endpoints: `Create a long lived access token` and `List WhatsApp Business Accounts details`. ## RCS ### Added - 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. # 1.0.108 2025-03-03 ## RCS ### Added - Enabled `T-Mobile CZ` operator. - Enabled `Slovak Telekom` operator. ## Bundles ### Added - Added `webhookDeliveryStatuses` presenting the delivery status of webhooks to targets. # 1.0.107 2025-02-20 ## Common - Improvement of services # 1.0.106 2025-02-17 ## Common - Improvement of services # 1.0.105 2025-02-10 ## Common - Improvement of services # 1.0.104 2025-02-05 ## WhatsApp ### Changed - Added `wrong_otp` error to sender verification endpoint. - Added filtering by Conversation API app ID to the list senders endpoint. # 1.0.103 2025-02-04 ## Common - Improvement of services # 1.0.102 2025-01-29 ## WhatsApp ### Changed - Fixed a bug causing list templates and list templates by name endpoints to sometimes break. # 1.0.101 2025-01-28 ## RCS ### Changed - 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_WEBVIEW` for `TestNumberFeatures`. - Allow specifying either email address or phone number to request sender launch. # 1.0.100 2025-01-21 ## Common - Improvement of services # 1.0.99 2025-01-16 ## Common - Improvement of services # 1.0.98 2025-01-16 ## Common - Improvement of services # 1.0.97 2025-01-16 ## Common - Improvement of services # 1.0.96 2025-01-16 ## WhatsApp ### Changed - Removed old deprecated template category. Currently available categories `AUTHENTICATION`, `MARKETING`, `UTILITY`. # 1.0.95 2025-01-13 ## Common - Improvement of services # 1.0.94 2025-01-08 ## WhatsApp ### Changed - Changed to accept `phoneNumber` for `SINCH` phone number provider (OBO sender). ## RCS ### Changed - Removed non-standard country codes from the sender endpoints response. # 1.0.93 2024-12-20 ## Common - Improvement of services # 1.0.92 2024-12-16 ## Common - Improvement of services # 1.0.91 2024-12-16 ## WhatsApp ### Added - Added `WHATSAPP_WABA_ACCOUNT_CHANGED` webhook trigger. - Added `primaryBusinessLocation` property to account endpoints response. # 1.0.90 2024-12-11 ## WhatsApp ### Added - Added `WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE` webhook trigger. # 1.0.89 2024-12-09 ## RCS ### Added - Added `RCS_SENDER_OPERATOR_STATUS_UPDATED` webhook trigger. - Added ability to relaunch sender using launch endpoint. - Added status `INVALID_IN_GOOGLE_MY_BUSINESS` for `countryStatus`. # 1.0.88 2024-12-05 ## WhatsApp ### Deprecated - Deprecated `packageName` and `signatureHash` properties in template OTP button input. - Deprecated field `cloudApi` for sender endpoints response. ### Added - Added `ZERO_TAP` to the list of allowed values for `otpType` property in template OTP button input. - Added `AE`, `AU`, `BH`, `CA`, `CH`, `GB`, `ID`, `IN`, `JP`, `KR`, `SG`, `ZA` to the list of allowed values for `metaLocalStorage` property in sender endpoints input and response. ### Changed - Removed previously deprecated properties `tpsProcessing` and `tpsPlan` as well as optional property `tpsChanged` in 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`, `TRANSACTIONAL` and `TRANSPORTATION_UPDATE` in template endpoints response. ## RCS ### Added - Added `add_test_number_not_allowed_before_launch` error to sender endpoints. - Added `US` as supported country for RCS. ### Changed - Changed `callbackUrl` to be optional for sender launching. # 1.0.87 2024-11-22 ## Common - Improvement of services # 1.0.86 2024-11-18 ## Common - Improvement of services # 1.0.85 2024-11-14 ## Common ### Changed - Changed errors for image validation. Instead of two errors `file_dimensions_too_small` and `file_dimensions_too_big` it will be one `file_has_wrong_dimensions` with image requirements. # 1.0.84 2024-11-11 ## RCS ### Added - Added `screenshotUris` to general questionnaire, as optional field. - Added `Netherlands` as supported country for RCS. # 1.0.83 2024-11-04 ## Common - Improvement of services # 1.0.82 2024-10-28 ## WhatsApp ### Changes - Removed `Stickerpack` endpoints which aren't supported for Cloud API. ## RCS ### Breaking Changes - Changed `useCase` parameter type in the questionnaire endpoint so that there is `MULTIUSE` value instead of `MULTI_USE`. ## Bundles ### Added - Added options for processing mode and retention policy for Conversation App. # 1.0.81 2024-10-21 ## RCS ### Added - 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. ### Changed - Set `region` property of the `conversationApiAppDetails` object in sender endpoints response to Conversation API app region instead of the sender region. # 1.0.80 2024-10-15 ## RCS ### Deprecated - Deprecated field `conversationApiApp` for sender endpoints. ### Added - Added the `conversationApiAppDetails` field to sender endpoints, providing details of the Conversation API app connected to the sender. # 1.0.79 2024-10-10 ## Common - Improvement of services ## RCS ### Breaking Changes - Changed response for testNumbers endpoint from array to object `{ testNumbers: [] }`. ### Changed - Fixed phone validation bug in sender update. # 1.0.78 2024-10-07 ## Common - Improvement of services ## RCS - Provisioning API for `RCS` service is OpenBeta. ### Added - Added new country status, which reflects the default state of a non-launched sender. # 1.0.77 2024-09-25 ## RCS ### Added - 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. ## WhatsApp ### Added - Added new type `UNIQUE_URL` for template analytics Button. # 1.0.76 2024-09-23 ## RCS ### Added - Added `RCS_ACCOUNT_COMMENT_ADDED` webhook trigger. - Added `RCS_SENDER_COMMENT_ADDED` webhook trigger. - Added `RCS_SENDER_STATUS_UPDATED` webhook trigger. ### Changed - Fixed bug where additional emails, phones, and websites were ignored during sender updates. ## WhatsApp ### Added - Added new value for `errorCode` for sender `WABA_CONNECTED_TO_ANOTHER_PROJECT`. # 1.0.75 2024-09-16 ## Common - Improvement of services # 1.0.74 2024-09-05 ## Common - Improvement of services # 1.0.73 2024-09-04 ## Common - Improvement of services ## RCS - Provisioning API for `RCS` service is Closed Beta. # 1.0.72 2024-09-02 ## Common - Improvement of services # 1.0.71 2024-08-28 ## Common - Improvement of services # 1.0.70 2024-08-26 ## Common - Improvement of services # 1.0.69 2024-08-19 ## Common - Improvement of services # 1.0.68 2024-08-12 ## Common - Improvement of services # 1.0.67 2024-08-05 ## WhatsApp ### Added - Added new optional field `messageSendTtlSeconds` for authentication template. ## Bundles - Provisioning API for `Bundles` service is GA. ## KakaoTalk - Provisioning API for `KakaoTalk` service is GA. ### Changed - Removed `Updates a sender in project` endpoint. # 1.0.66 2024-07-24 ## WhatsApp ### Added - Added optional `metaLocalStorage` properties. 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. # 1.0.65 2024-07-19 ## Common - Improvement of services # 1.0.64 2024-07-18 ## Common - Improvement of services # 1.0.63 2024-07-15 ## WhatsApp ### Breaking Changes - Removed the `Get a temporary URL for Facebook login` endpoint. 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. ### New features - Verify if Meta Template Analytics is enabled for the WhatsApp Business Account. ### Deprecated - Deprecated field `tpsPlan` for get sender endpoint. ### Added - Added `maxTps` field to maximum tps, on get sender endpoint. - Added `wabaEnabledForInsights` field to show status for Meta Template Analytics, on get account endpoint. ### Changed - Deprecated field `tpsPlan` for get sender endpoint. - Removed `Get a temporary URL for Facebook login` endpoint. # 1.0.62 2024-07-08 ## Common - Improvement of services # 1.0.61 2024-06-28 ## WhatsApp ### Added - Added `WHATSAPP_TEMPLATE_CATEGORY_UPDATED` webhook trigger. - Added available value `REINSTATED` for optional `newState` field for webhook payload for `WHATSAPP_TEMPLATE_STATUS_UPDATED` type. # 1.0.60 2024-06-24 ## WhatsApp ### Added - Added readonly field `compatibleRegions` to endpoints `Get account for project` and `Get sender for project`. This field can be used to determine which Conversation API regions the sender is compatible with. ### Changed - Fixed bug sometimes showing wrong order of template components. - Changed to optional `region` properties in request body for endpoint: `Create sender for project`. If not provided region will be automatically selected based on the country for billing address. # 1.0.59 2024-06-17 ## Common - Improvement of services # 1.0.58 2024-06-10 ## Common - Improvement of services # 1.0.57 2024-06-03 ## Bundles ### Added - Added trigger for conversation app: `MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION`. - Added statues for sms app: `PROVISIONING_ADD`, `PROVISIONING_UPDATE`, `PROVISIONING_ADD_FAILED` and `PROVISIONING_UPDATE_FAILED`. ## KakaoTalk ### Added - Added list sender categories endpoint. ## WhatsApp ### Deprecated - Deprecated `Get a temporary URL for Facebook login` endpoint. New Meta registration flow with solution id makes this endpoint redundant. ### Added - Added optional `businessManager` properties in request body for WhatsApp endpoints: `List WhatsApp Business Accounts details`, `Create a long lived access token`, `Create account for project`, `Create sender for project` and query parameter for `Get 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 `errorCode` for sender `SENDER_HAS_BEEN_DELETED`. ### Changed - 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 login` endpoint. # 1.0.56 2024-05-30 ## WhatsApp ### Breaking Changes - Reducing the size of the header example for image from 16MB to 5MB. ### Deprecated - Deprecated fields `wabaBanState` and `wabaBanDate` for get sender endpoint. Get account endpoint should be used to get this information. ### Added - Added `WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED` webhook trigger. ### Changed - Align media header example file mime types and max sizes in accordance with the META documentation: `DOCUMENT` - 100MB and `application/pdf` mime types, `IMAGE` 5MB and `image/jpeg, image/png` mime types, `VIDEO` - 16MB and `video/mp4, video/3gp` mime types. - Removed available value `REINSTATED` for optional `newState` field for webhook payload for `WHATSAPP_TEMPLATE_STATUS_UPDATED` type. - Align media header example file mime types and max sizes in accordance with the META documentation: `DOCUMENT` - 100MB and `text/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.sheet` mime types, `IMAGE` 5MB and `image/jpeg, image/png, image/webp` mime types, `VIDEO` - 16MB and `video/mp4, video/3gp` mime types. - Deprecated fields `wabaBanState` and `wabaBanDate` for get sender endpoint. Get account endpoint should be used to get this information. # 1.0.55 2024-05-20 ## Common ### Changed - Updated detecting mime type for file url. ## WhatsApp ### Added - 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. # 1.0.54 2024-05-13 ## Common - Improvement of services # 1.0.53 2024-05-06 ## KakaoTalk ### Added - Added `KAKAOTALK_SENDER_COMMENT_ADDED` webhook trigger. - Added `KAKAOTALK_SENDER_REJECTED` webhook trigger. # 1.0.52 2024-04-30 ## KakaoTalk ### Added - Added `KAKAOTALK_SENDER_INACTIVE` webhook trigger. ### Changed - changed endpoint for `List all template categories in project`. ## WhatsApp ### Added - Added endpoint to enable Template Analytics. ### Changed - Allow update `category` and `allowChangeCategory` flag for `DRAFT` template or `REJECTED` with rejectionCode equals `INCORRECT_CATEGORY`. # 1.0.51 2024-04-22 ## WhatsApp ### New features - Get number of times templates have been sent, delivered, read and clicked when using get template endpoint, based on Meta template analytics. ### Added - Added field `previousPageToken` to all list endpoints. - Added `qualityScore` property for template `QUALITY_SCORE_GREEN`, `QUALITY_SCORE_YELLOW`, `QUALITY_SCORE_RED`, `QUALITY_SCORE_UNKNOWN` and `UNRECOGNIZED`. - Added `analytics` to get template endpoint. ### Changed - Removed optional `cloudApi` flag from the `Create sender for project` request 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`. ## KakaoTalk ### Added - Added field `previousPageToken` to endpoint `list all senders in project`. - Added field `previousPageToken` to endpoint `list all categories in project`. - Added field `previousPageToken` to endpoints `lists activities on project template` and `lists activities on sender`. - Added field `previousPageToken` to endpoint `list all templates in project`. ### Changed - Removed `KAKAOTALK_TEMPLATE_DELETED` webhook trigger because it's redundant. - Changed page max size to 1000 for endpoint `list all templates in project`. ## RCS ### Added - Added field `previousPageToken` to endpoints `list all senders in project` and `lists activities on sender`. ## Webhooks ### Added - Added field `previousPageToken` to endpoint `list all webhooks in project`. # 1.0.50 2024-04-15 ## WhatsApp ### Changed - Fix validation for template `name` to 512 characters. # 1.0.49 2024-04-08 ## Common - Improvement of services # 1.0.48 2024-04-02 ### Removed - Removed `v1alpha1` and `v1alpha2` endpoints. ## WhatsApp ### Changed - Fixed validation in case of not sending `status` when creating and updating for sender and template. - Removed `businessManager` properties from request body for WhatsApp endpoints: `List WhatsApp Business Accounts details`, `Create a long lived access token`, `Create account for project`, `Create sender for project` and query parameter for `Get a temporary URL for Facebook login`. Currently, businessManager will be automatically selected based on the country for billing address. - Removed `region` from query parameter for `Get a temporary URL for Facebook login`. ## KakaoTalk ### Added - Added `KAKAOTALK_SENDER_ACTIVE` webhook trigger. - Added `KAKAOTALK_TEMPLATE_COMMENT_ADDED` webhook trigger. ### Changed - Fixed validation in case of not sending `status` when creating and updating template. # 1.0.47 2024-03-25 ## Common - Improvement of services # 1.0.46 2024-03-18 ## KakaoTalk ### Added - Added `KAKAOTALK_TEMPLATE_DELETED` webhook trigger. - Added `KAKAOTALK_TEMPLATE_REJECTED` webhook trigger. - Added `KAKAOTALK_TEMPLATE_APPROVED` webhook trigger. # 1.0.45 2024-03-11 ## WhatsApp ### New Features - Added optional properties if waba is banned; `wabaBanState` and `wabaBanDate`. ### Added - Added optional properties if waba is banned - `wabaBanState` - `DISABLE / REINSTATE / SCHEDULE_FOR_DISABLE / UNRECOGNIZED` and `wabaBanDate`. - Added optional properties if waba is banned - `wabaBanState` - `DISABLE / REINSTATE / SCHEDULE_FOR_DISABLE / UNRECOGNIZED` and `wabaBanDate`. ### Changed - Fixed `WHATSAPP_TEMPLATE_DELETED` webhook trigger. # 1.0.44 2024-03-04 ## Bundles ### Added - Added Brazil (`BR`) region. # 1.0.43 2024-02-26 ## Common - Improvement of services # 1.0.42 2024-02-19 ## Common - Improvement of services # 1.0.41 2024-02-12 ## Common - Improvement of services # 1.0.40 2024-02-09 ## WhatsApp ## New features - Allowing `SINCH_UK` business manager to be used for cloud api senders in EU region. ### Added - Allowing `SINCH_UK` business manager to be used for both cloud api senders in EU region. # 1.0.39 2024-02-06 ## Common - Improvement of services # 1.0.38 2024-02-01 ## Common - Provisioning API for `WhatsApp` and `Webhook` services is GA. # 1.0.37 2024-01-31 ## KakaoTalk ### Changed - Fixed broken endpoint to update sender. # 1.0.36 2024-01-22 ## KakaoTalk ### New Features - 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 - Added endpoint to delete sender changes. - Added endpoint to create sender comments. - Added endpoint to update sender. ## WhatsApp ### New Features - Added `facebookCode` for create sender and create long lived access token. - Added new query parameter `type` to get login url endpoint. - Added optional `newState` field for webhook payload for `WHATSAPP_TEMPLATE_STATUS_UPDATED` type. ### Added - Added `facebookCode` parameter to createSender endpoint. - Added `facebookCode` parameter to longLivedAccessToken endpoint. - Added parameter `type` (`ACCESS_TOKEN / CODE`) to get login endpoint. Default value: `ACCESS_TOKEN`. This parameter `type` will be removed 1st of February and response will be as for type equals `CODE`. - Added optional `newState` field for webhook payload for `WHATSAPP_TEMPLATE_STATUS_UPDATED` type. Available values: `DISABLED`, `PAUSED`, `REINSTATED` and `UNPAUSED`. ### Changed - Fixed "List all stickerpacks for sender" endpoint, `pageToken` and `pageSize` shouldn't be required parameters. # 1.0.35 2023-12-21 ## Common - Improvement of services # 1.0.34 2023-12-19 ## RCS ### New Features - Including `status` in body when creating a sender is optional. Logically it will default to submit if not provided. ### Changed - Creating senders without providing `status` will default to submit. ## WhatsApp ### New Features - Added new endpoints to create, update, delete stickerpack. - Added new endpoints to create, update, delete sticker. - Including `status` in body when creating a template is optional. Logically it will default to submit if not provided. - Including `status` in 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 - 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. ### Changed - Fixed validation for missing `example` for `HEADER` and `examples` for `BODY` components. - Creating templates without providing `status` will default to submit. - Creating senders without providing `status` will 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. ## KakaoTalk ### New Features - Including `status` in body when updating a template is optional. Logically it will default to draft if not provided. - Including `status` in body when creating a sender is optional. Logically it will default to submit if not provided. - Including `status` in body when creating a template is optional. Logically it will default to submit if not provided. - Added English names for template categories. ### Added - Added field `nameEnglish` to categoryDto and subcategoryDto for endpoint list of categories. ### Changed - Improved validation for methods create and update template with status `draft`. - , ] - Improve validation of category code when creating new sender. - Updating templates without providing `status` will default to draft. - Creating senders without providing `status` will default to submit. - Improved validation for create and update template endpoints. - Creating templates without providing `status` will default to submit. - Improved validation of name length when creating a new sender. # 1.0.33 2023-11-20 ## WhatsApp ### Changed - 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. # 1.0.32 2023-11-08 ## WhatsApp ### Changed - Fixed `WHATSAPP_TEMPLATE_REJECTED` webhook trigger. # 1.0.31 2023-11-07 ## Common ### New Features - With this release we have added the `v1` endpoints. These are based on the `v1alpha2` endpoints and should therefore be an easy migration in that case. ### Deprecated - The `v1alpha1` endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date. To migrate from `v1alpha1` to `v1alpha2` or `v1`, please follow the [migration guide](/assets/migration.e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.7646f792.md). - The `v1alpha2` endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date. To migrate from `v1alpha2` to `v1`, please follow the [migration guide](/assets/migration.e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.7646f792.md). ### Added - Added v1 endpoints. ## WhatsApp ### Breaking Changes - The output for authentication templates is updated to not contain fields that are not valid for this category. Fields that have been removed are `text` and `examples` in body and footer components. The change is only applied to `v1alpha2` and `v1`. - The previously deprecated field `v1payload` in WhatsApp webhooks have now been removed. ### Changed - Fixed `WHATSAPP_TEMPLATE_APPROVED` webhook trigger. - Removed fields from output that are not valid for authentication templates. - Default value for field `status` equals `SUBMIT` for 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. ## KakaoTalk ### New Features - Added new endpoint for update existing template. - Added new endpoint to create sender. ### Added - Added endpoint to update template. - Added new endpoint to create sender. ### Changed - Fixed showing the change request status even if there are no changes requested. # 1.0.30 2023-10-12 ## WhatsApp ### New Features - Endpoints for retrieving WhatsApp sticker packs for a sender. Can be requested for different namespaces, WhatsApp (first-party) or user (third-party) maintained. ### Breaking Changes - 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 - Added optional query `namespace` to stickerpack endpoints. ### Changed - 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. # 1.0.29 2023-10-09 ## WhatsApp ### Added - Added new list endpoint for stickerpacks. - Improved errors for create template for message body format incorrect. # 1.0.28 2023-10-03 ## WhatsApp ### Changed - Restore old template languages for v1alpha1. - Fixed `WHATSAPP_TEMPLATE_DELETED` webhook trigger. # 1.0.27 2023-10-03 ## WhatsApp ### Changed - Fixed issue where a template with a draft change with no changes was not showing up in changes field. # 1.0.26 2023-10-02 ## KakaoTalk ### New Features - Added query parameters: `filterStates` and `filterStatuses` for senders and templates. ### Breaking Changes - 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`, `templateStatus` and `senderState`. - Replaced values for `status` - `draft / submit` by `DRAFT / SUBMIT`. - Replaced values for enums to upper case. ### Added - Added optional `saveDraftOnFailure` flag to save obo sender if submission fails. Defaults to false. - Added query parameters: `filterStates` and `filterStatuses` for senders and templates. Can be given multiple enum values separated using comma. - Added optional `saveDraftOnFailure` flag to save template if submission fails. Defaults to false. - Added endpoint to remove template from project. ### Changed - Remove query parameters: `sortColumn`, `sortDirection`, `templateStatus` and `senderState`. - Change values for `status` field sender and template request to `DRAFT / SUBMIT`. - Change values for enums to upper case. - Updated error message when no template draft was found when trying to remove. ## WhatsApp ### New Features - Added query parameters: `filterStates` and `filterStatuses` for senders and templates. ### Breaking Changes - 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 `saveDraftOnFailure` to `false` in create template endpoint. - Removed query parameters: `sortColumn`, `sortDirection`, `templateState` and `senderState`. - Replaced values for `status` - `draft / submit` by `DRAFT / SUBMIT`. - Replaced values for enums to upper case. ### Added - Add `WHATSAPP_TEMPLATE_DELETED` webhook trigger. - Added new compare templates endpoint. - Added query parameters: `filterStates` and `filterStatuses` for 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. ### Changed - 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`, `templateState` and `senderState`. - Change values for `status` field sender and template request to `DRAFT / 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 `saveDraftOnFailure` to `false` in create template endpoint. ## RCS ### New Features - Added query parameters: `filterStates` and `filterStatuses` for senders and templates. ### Breaking Changes - Removed query parameters: `sortColumn`, `sortDirection` and `senderState`. - Replaced values for `status` - `draft / submit` by `DRAFT / SUBMIT`. - Replaced values for enums to upper case. ### Added - Added query parameters: `filterStates` and `filterStatuses` for sender. Can be given multiple enum values using comma. ### Changed - Removed query parameters: `sortColumn`, `sortDirection` and `senderState`. - Change values for `status` field sender request to `DRAFT / SUBMIT`. - Change values for enums to upper case. # 1.0.25 2023-09-14 ## KakaoTalk ### Added - Added endpoint to remove template drafts. ## WhatsApp ### 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. # 1.0.24 2023-09-11 ## KakaoTalk ### Added - Added endpoint to get list of template activities. - Added endpoint to create template comment. ## WhatsApp ### 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`. # 1.0.23 2023-08-28 ## WhatsApp ### Added - Added new status `DISABLED` for templates. Allow editing `DISABLED` status. ## KakaoTalk ### Added - Added endpoint to get list of categories for template. # 1.0.22 2023-08-10 ## Common - Improvement of services # 1.0.21 2023-07-10 ## WhatsApp ### 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`. # 1.0.20 2023-06-28 ## WhatsApp ### Changed - Fixed file uploading for update template. # 1.0.19 2023-06-21 ## WhatsApp ### Changed - Corrected the response for the edited sender. # 1.0.18 2023-06-19 ## WhatsApp ### Added - Added version 2 for templates. - Added Message Template header type `LOCATION`. ## Telegram ### Changed - A telegram channel with no followers unexpectedly threw an error. It now correctly returns `0` followers. # 1.0.17 2023-06-01 ## WhatsApp ### Changed - Fixed deleting templates for `IN_PROGRESS` state. # 1.0.16 2023-05-26 ## WhatsApp ### Breaking Changes - Rename `errorMessage` to `rejectionCode` in template. ### Changed - Renamed `errorMessage` to `rejectionCode` in template. # 1.0.15 2023-05-26 ## WhatsApp ### 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. # 1.0.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. ## WhatsApp ### 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. # 1.0.13 2023-05-16 ## WhatsApp ### 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. # 1.0.12 2023-04-26 ## WhatsApp ### 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 # 1.0.11 2023-04-05 ## WhatsApp ### 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. # 1.0.10 2023-03-27 ## WhatsApp ### 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. # 1.0.9 2023-03-13 ## KakaoTalk ### Added - Added list endpoint for sender. - Added get endpoint for sender. - Added endpoint to get and list templates. ## WhatsApp ### 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. # 1.0.8 2023-02-28 ## Bundles ### Added - Added current `state` field for bundle response. ### Changed - Fixed triggering webhook if conversation app had set sms credentials. # 1.0.7 2023-02-08 ## WhatsApp ### Changed - Additional validation of the phoneNumberId used to create the ES. - Improve errors for list WABA and create long lived access token endpoint. # 1.0.6 2023-02-07 ## WhatsApp ## WhatsApp ### 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. # 1.0.5 2023-01-31 ## WhatsApp ### 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. # 1.0.4 2023-01-16 ## WhatsApp ### 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. # 1.0.3 2022-12-20 ## WhatsApp ### 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. # 1.0.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. ## WhatsApp ### 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. # 1.0.1 2022-11-14 ## WhatsApp ### 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. # 1.0.0 2022-11-09 ## WhatsApp ### 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: 1. 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. 2. Authorize Sinch to manage the WABA on behalf of the end user and wait for the account to be onboarded. 3. Create a new OBO sender. Once the account is onboarded a sender can be created for the project. 4. 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.