Skip to main content
This archive preserves the dated entries from the previous API documentation, through July 13, 2026. A historical announcement describes the contract at that time; later entries and the current API reference take precedence.
For current billing, see WhatsApp pricing. The 2025 pricing migration is retained separately for interpreting older records.

​
2026-07-13

  • Added a WABA-level Automatic Creative Optimizations query API: GET /v2/whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations.
  • Added a WABA-level Automatic Creative Optimizations partial update API: PATCH /v2/whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations.

​
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

Historical announcement: this entry does not establish current group-message webhook availability. Use the current Groups guide and published webhook catalog for supported operations and events.
  • 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

The original changelog records this date as 2025-05-08. Its position among 2026 entries is preserved without inferring a different release date.

​
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 (GET /v2/whatsapp/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

​
2026-01-28

​
2025-12-15

​
2025-12-03

  • Support WhatsApp interactive-media-carousel-messages .
  • contact-retrieve (GET /v2/contact/contacts/{id})/contact-update (PATCH /v2/contact/contacts/{id})/contact-delete (DELETE /v2/contact/contacts/{id}) 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 (GET /v2/unsubscribers)endpoint
  • Added source to the response of the List all unsubscribers by customer (GET /v2/unsubscribers/{customer})endpoint
  • Added source to the response of the Retrieve an unsubscriber (GET /v2/unsubscribers/{customer}/{channel}) endpoint
  • Added new webhook event types: contact.unsubscribe.created, contact.unsubscribe.deleted See also:

​
2025-10-20

  • Added whatsappBusinessManagerMessagingLimit field to multiple endpoints:
    • List WABAs (GET /v2/whatsapp/businessAccounts) and Retrieve a WABA (GET /v2/whatsapp/businessAccounts/{id}) endpoints
    • List phone numbers (GET /v2/whatsapp/phoneNumbers) and Retrieve a phone number (GET /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}) endpoints
    • whatsapp.phone_number.quality_updated webhook payload

​
2025-10-10

  • Added businessId, businessStatus and businessName to the response of the List WABAS (GET /v2/whatsapp/businessAccounts) endpoint and Retrieve a WABA (GET /v2/whatsapp/businessAccounts/{id}) endpoint

​
2025-09-24

  • Support Update a phone number’s display name endpoint
  • Added newName to the response of the List phone numbers (GET /v2/whatsapp/phoneNumbers) endpoint and Retrieve a phone number (GET /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}) endpoint.
  • Added verifiedName, nameStatus and newName to the response of the Retrieve a phone number profile (GET /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/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 (POST /v2/whatsapp/flows) for specifying Flow endpoint URI
    • Add endpointUri parameter to Flow metadata update API (PATCH /v2/whatsapp/flows/{flowId}/metadata) for endpoint configuration
    • Add endpointUrl resource returned in Flow detail API (GET /v2/whatsapp/flows/{flowId})

​
2025-08-28

​
2025-08-20

  • Add New WhatsApp Calling APIs
    • Initiate an outbound WhatsApp call (POST /v2/whatsapp/calls/connect)
    • Pre-accept an inbound WhatsApp call (POST /v2/whatsapp/calls/preAccept)
    • Accept an inbound WhatsApp call (POST /v2/whatsapp/calls/accept)
    • Terminate a WhatsApp call (POST /v2/whatsapp/calls/terminate)
    • Reject an inbound WhatsApp call (POST /v2/whatsapp/calls/reject)
  • Add Configure Call Settings APIs
    • Get business phone number calling settings (GET /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings)
    • Configure business phone number calling settings (POST /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings)
  • Add New WhatsApp Calling Webhooks
  • Whatsapp Calling Usage Guide: whatsapp-calling-examples

​
2025-08-04

  • Add whatsapp flow preview (GET /v2/whatsapp/flows/{flowId}/preview) web page supprot

​
2025-07-24

  • Added newsupported_apps array field to Create a template (POST /v2/whatsapp/templates) 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 (GET /v2/contact/contacts/attributes) support for querying all defined contact attributes.
  • Added new webhook event types: contact.created, contact.deleted, and contact.attributes_changed. See also:
  • Added a new property eventProperties to the following webhook endpoint APIs:
    • Create a webhook endpoint (POST /v2/webhookEndpoints)
    • Update a webhook endpoint (PATCH /v2/webhookEndpoints/{id})
    • List webhook endpoints (GET /v2/webhookEndpoints)
    • Retrieve a webhook endpoint (GET /v2/webhookEndpoints/{id})
  • 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 (POST /v2/whatsapp/flows) 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

​
2024-09-12

​
2024-08-22

  • Add Custom Events API. See Send an event (POST /v2/event/events).

​
2024-08-02

  • Add lastMessageToPhoneNumber to the Contact object. See Retrieve a contact (GET /v2/contact/contacts/{id}).

​
2024-07-18

  • Add filterBlocked to the Enqueue a WhatsApp Message (POST /v2/whatsapp/messages) endpoint. If set to true, we will not send messages to users in your block list.

​
2024-05-24

​
2024-04-03

  • Add regionCode to the WhatsApp Message object.

​
2024-02-22

  • Add WhatsApp Mark message as read (POST /v2/whatsapp/inboundMessages/{id}/markAsRead) endpoint.

​
2024-01-30

​
2024-01-17

  • Add parameter externalId to Start a verification (POST /v2/verify/verifications) endpoint.

​
2024-01-05

  • Add Register a phone number (POST /v2/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/register) endpoint.
  • Add id to the WhatsApp Phone Number object.
  • Add paymentMethodAttached to the WhatsApp Business Account object.

​
2023-12-21

​
2023-12-13

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

​
2023-11-24

​
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

​
2023-10-18

​
2023-10-12

​
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

​
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