Changelog

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 value TIER_NOT_SET to enum WhatsApp Phone Number messagingLimit.

2023-03-24

• WhatsApp conversations are charged when the first message of this conversation is delivered 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