Changelog

2026-07-07

Updated

• Updated WhatsApp Business Username status documentation to use reserved for Business Username requests that are reserved by Meta and may still be under review.
• Marked pending_review as a legacy compatibility value. New Business Username writes use reserved.

Added

• Added reserved to the WhatsApp Business Username status enum.
• Added a whatsapp.phone_number.business_username_updated webhook example with businessUsernameStatus set to reserved.

2026-06-10

Updated

• Reverted the previously documented WhatsApp Business Account removed state introduced on 2026-05-25.
• Partner removal events are now represented by whatsapp.business_account.deleted webhook payloads instead of whatsapp.business_account.updated.
• removedReason, removedInitiatedBy, and removedTime are retained as optional removal metadata on deleted WhatsApp Business Account webhook payloads.

Added

• Added PARTNER_APP_UNINSTALLED to WhatsappBusinessAccountUpdateEventEnum.

2026-06-08

Added

• New field on the WhatsApp Phone Number object:
  • updateEvent
• Added updateEvent to whatsapp.phone_number.quality_updated webhook payloads to identify the account update event that triggered the phone number status change, such as ACCOUNT_OFFBOARDED or ACCOUNT_RECONNECTED.

2026-06-01

Added

• New APIs for querying, updating, deleting, and retrieving suggestions for WhatsApp Business Usernames.
• New fields on the WhatsApp Phone Number object:
  • businessUsername
  • businessUsernameStatus
  • requestedBusinessUsername
  • businessUsernameUpdatedAt
• New webhook event type: whatsapp.phone_number.business_username_updated.

2026-05-25

• Support WhatsApp Business Account Partner Removed updates in whatsapp.business_account.updated webhooks.
  • Added removed, removedReason, removedInitiatedBy, and removedTime to WhatsApp Business Account webhook payloads.
  • Added PARTNER_REMOVED to WhatsApp Business Account updateEvent.
  • Documented known Partner Removed reasons: ACCOUNT_DISCONNECTED, BUSINESS_DOWNGRADE, CHANGE_NUMBER, COMPANION_INACTIVITY, PRIMARY_INACTIVITY, and USER_RE_REGISTERED.
  • Documented known Partner Removed initiators: USER and SYSTEM.

2026-05-19

• Support WhatsApp Groups API.
• Support WhatsApp group invite link, join request, participant, and settings operations.
• Added group_id to WhatsApp template component parameters.
• Added WhatsApp group webhook event types and whatsappGroup payloads. See also Webhook Events & Payloads and Webhook Payload Examples.
• Added groupId to WhatsApp inbound message payloads for group messages.

2025-05-08

• Support WhatsApp inbound-unsupported-message UNSUPPORTED_TYPE

2026-04-29

• Added ARCHIVED to WhatsApp template status.
• Added ARCHIVED and UNARCHIVED to WhatsApp template statusUpdateEvent.
• Added webhook examples for WhatsApp template archived and unarchived events. See also WhatsApp Template Reviewed Webhook Examples.
• Added filter.status to the List templates endpoint to filter templates by status, including ARCHIVED.

2026-03-13

• To support Meta's BSUID rollout starting March 31, 2026, YCloud has updated several webhook payloads related to messaging and user identity. see BSUID-Related Webhook Updates

2026-03-04

• Support WhatsApp interactive-media-carousel-messages-with-quick-reply-buttons

2026-01-28

• Support WhatsApp create Gif template/send Gif template message

2025-12-15

• Support WhatsApp deep link template

2025-12-03

• Support WhatsApp interactive-media-carousel-messages .
• contact-retrieve/contact-update/contact-delete support phone number.

2025-11-06

• Added new webhook event type: whatsapp.user.preferences

2025-10-22

• Added source to the response of the List unsubscribers endpoint
• Added source to the response of the List all unsubscribers by customer endpoint
• Added source to the response of the Retrieve an unsubscriber endpoint
• Added new webhook event types: contact.unsubscribe.created, contact.unsubscribe.deleted See also:
  • Contact Unsubscribe Created Webhook Examples
  • Contact Unsubscribe Deleted Webhook Examples

2025-10-20

• Added whatsappBusinessManagerMessagingLimit field to multiple endpoints:
  • List WABAs and Retrieve a WABA endpoints
  • List phone numbers and Retrieve a phone number endpoints
  • whatsapp.phone_number.quality_updated webhook payload

2025-10-10

• Added businessId, businessStatus and businessName to the response of the List WABAS endpoint and Retrieve a WABA endpoint

2025-09-24

• Support Update a phone number's display name endpoint
• Added newName to the response of the List phone numbers endpoint and Retrieve a phone number endpoint.
• Added verifiedName, nameStatus and newName to the response of the Retrieve a phone number profile
• Added the whatsappBusinessManagerMessagingLimit field to the payload of the whatsapp.phone_number.quality_updated webhook

2025-09-01

• Add WhatsApp Flow endpoint redirection feature support
  • Add endpointUri parameter to Flow creation API for specifying Flow endpoint URI
  • Add endpointUri parameter to Flow metadata update API for endpoint configuration
  • Add endpointUrl resource returned in Flow detail API

2025-08-28

• Add New WhatsApp Smb Webhooks
  • WhatsAppSmbAppStateSync-webhook-examples

2025-08-20

• Add New WhatsApp Calling APIs
  • Initiate an outbound WhatsApp call
  • Pre-accept an inbound WhatsApp call
  • Accept an inbound WhatsApp call
  • Terminate a WhatsApp call
  • Reject an inbound WhatsApp call
• Add Configure Call Settings APIs
  • Get business phone number calling settings
  • Configure business phone number calling settings
• Add New WhatsApp Calling Webhooks
  • whatsapp-calling-connect-webhook-examples
  • whatsapp-calling-status-update-webhook-examples
  • whatsapp-calling-terminate-webhook-examples
• Whatsapp Calling Usage Guide: whatsapp-calling-examples

2025-08-04

• Add whatsapp flow preview web page supprot

2025-07-24

• Added newsupported_apps array field to Create a template for defining multiple app package names and signing key hashes (up to 5 apps) in one OTP template (One-tap / Zero-tap).
  • Deprecated existing package_name and signature_hash fields in favor of the new supported_apps array structure

2025-07-10

• Added List contact attributes support for querying all defined contact attributes.
• Added new webhook event types: contact.created, contact.deleted, and contact.attributes_changed. See also:
  • Contact Created Webhook Examples
  • Contact Deleted Webhook Examples
  • Contact Attributes Changed Webhook Examples
• Added a new property eventProperties to the following webhook endpoint APIs:
  • Create a webhook endpoint
  • Update a webhook endpoint
  • List webhook endpoints
  • Retrieve a webhook endpoint
• Added new fields to Contact object to track contact source information:
  • sourceType: Contact source type enumeration (WHATSAPP, GROWTH_TOOL, MANUALLY_ADDED, FILE_IMPORT, SHOPIFY, API, AD, POST, CALLING, SMB, UNKNOWN)
  • sourceId: Source identifier for tracking contact creation source
  • sourceUrl: Source URL where the contact was created

2025-07-01

• Added WhatsApp Flow API support with the following endpoints:
  • Create a flow、List flows、Update flow metadata、Update flow structure、Delete a flow、Retrieve a flow、Publish a flow、Deprecate a flow

2024-10-10

• Support WhatsApp Order Details messages and Order Status messages.
• Add new webhook event type whatsapp.payment.updated. See also WhatsApp Payment Updated Webhook Examples .

2024-09-12

• Support WhatsApp Flows. See also Flow template, Flow template message, Interactive Flow message, and Inbound Interactive Flow Response message.

2024-08-22

• Add Custom Events API. See Send an event.

2024-08-02

• Add lastMessageToPhoneNumber to the Contact object. See Retrieve a contact.

2024-07-18

• Add filterBlocked to the Enqueue a WhatsApp Message endpoint. If set to ture, we will not send messages to users in your block list.

2024-05-24

• Starting June 1, 2024, WhatsApp is introducing a new authentication-international rate in Indonesia and India. See Authentication-International Rates .
• Add pricingCategory to the WhatsApp Message object. If an authentication conversation is billed at the authentication-international rate, the whatsapp.message.updated webhooks will have its pricingCategory property set to authentication_international.
• Add authIntlRateEligibilityCountries and primaryBusinessLocation to the WhatsApp Business Account object. Subscribe to the Authentication-International Rate Eligibility and Primary Business Location Update webhooks to be notified.

2024-04-03

• Add regionCode to the WhatsApp Message object.

2024-02-22

• Add WhatsApp Mark message as read endpoint.

2024-01-30

• Support WhatsApp Interactive Location Request message.
• Support WhatsApp Inbound Request Welcome message.
• Change authentication template message time-to-live from 24 hours to 30 days if never set (i.e., messageSendTtlSeconds is -1).

2024-01-17

• Add parameter externalId to Start a verification endpoint.

2024-01-05

• Add Register a phone number endpoint.
• Add id to the WhatsApp Phone Number object.
• Add paymentMethodAttached to the WhatsApp Business Account object.

2023-12-21

• Add Unsubscribers endpoints.

2023-12-13

• Add request parameter filterUnsubscribed to the Enqueue a WhatsApp message endpoint. If set to true, the message will not be sent to users who have unsubscribed from your account.

2023-11-24

• Support WhatsApp Catalog template and Catalog template message.
• Support WhatsApp Multi-Product Message template and MPM template message.
• Support WhatsApp Interactive Catalog message.
• Add the Update commerce settings endpoint to enable or disable the shopping cart or the product catalog for a specific business phone number.

2023-11-02

• Support WhatsApp Zero-Tap Authentication template.
• Add message time-to-live for authentication templates. Defaults to 600 seconds for newly created authentication templates.

2023-10-27

• Support WhatsApp Limited-Time Offer template and Limited-Time Offer template message.
• Support WhatsApp Carousel template and Carousel template message.

2023-10-18

• Support WhatsApp Interactive CTA URL Button messages. See also Interactive CTA URL Message Example.

2023-10-12

• Add webhook event type whatsapp.business_account.deleted, and whatsapp.phone_number.deleted.
• Support WhatsApp Coupon Templates. For more examples, see also Coupon template, and Coupon template message.

2023-09-07

• Add Contacts API /v2/contact/contacts. Use it to create, update, or delete your contacts.

2023-07-05

• Add conversation.type to the WhatsApp Message object. If present, possible values are FREE_ENTRY, FREE_TIER, and REGULAR.
• Add isOfficialBusinessAccount to the WhatsApp Phone Number object.

2023-06-01

• Add rate limit headers to each response. See also Rate Limits.

2023-05-26

• Add webhook event type whatsapp.template.quality_updated to help you keep track of WhatsApp Template Quality Rating updates. See Webhook Events & Payloads.
• Add quaityRating to the WhatsApp Template object.

2023-05-16

• Add WhatsApp messaging API /v2/whatsapp/messages/sendDirectly. See also WhatsApp Errors for error handling.
• Add WhatsApp template deletion API DELETE /v2/whatsapp/templates/{wabaId}/{name}/{language}.
• Add whatsappApiError to the response body error object.
• Add qualityUpdateEvent to the WhatsApp Phone Number object.
• Add sendTime, deliverTime, and readTime to the WhatsApp Message object.
• Add new enum value TIER_NOT_SET to WhatsApp Phone Number messagingLimit.

2023-03-24

• WhatsApp conversations are charged when the first message of this conversation isdelivered instead of sent. Thus, the totalPrice field of WhatsApp message objects is only an estimated price before the message is delivered, and it becomes the final price when the status is delivered or read. The balance taken up by those messages that are sent but haven't been delivered will not be available until the messages are dropped (Sent messages that are not delivered for 30 days are dropped). The conversation.expireTime is also an estimated expiration time until the first message of this conversation is delivered or read.
• Add webhook event type whatsapp.template.category_updated to help you keep track of WhatsApp template category changes. See WhatsApp template category updated payload. For more information about template category migration, see also First template category migration.
• Add new WhatsApp conversation origin types: authentication, marketing, utility, and service. The switch to the new pricing model will be performed on June 1, 2023. See also New conversation rates, effective June 1, 2023.
• Support creating Authentication Templates With One-Time Password Buttons, which will be available starting May 1, 2023, and will be mandatory starting May 29, 2023.

2023-03-09

• Add response header YCloud-Request-ID for each request. See Request ID.
• Add requestId to the response error object. See Errors.
• Add new WhatsApp template categories: AUTHENTICATION, and UTILITY. See also Pricing Change Launch Timeline