Changelog

Versioning#

The API version is part of the path: /v1. Within a version, changes are backwards compatible. The following are not considered breaking and can happen at any time, so write your integration to tolerate them:

• New endpoints, new optional request parameters and new response fields.
• New values in enumerations such as message type, error code, event type and channel capabilities.
• New webhook event types. Endpoints subscribed to * receive them automatically.
• Changes to the wording of error messages.

v1: initial release#

The first public version of the API (OpenAPI document version 1.0.0).

• Messages: send single messages and batches of up to 100, retrieve and list messages, read status history.
• Message types: text, attachments, template, button, list, cta_url, location, contacts and poll, plus channel-specific pass-through types.
• Channels: WhatsApp Business, Telegram, SMS, SMS OTP, Messenger, Instagram and TikTok. Connect, list, rename and delete channels; list WhatsApp templates.
• Webhooks: 14 event types, HMAC-SHA256 signatures, eight retries with backoff, endpoint management and test events.
• Billing: prepaid wallet and message packages, charge on acceptance, automatic refunds for failed messages, balance, pricing and usage endpoints.
• Platform: live and test modes with sandbox channels, scoped API keys with IP allowlists, idempotency keys, cursor pagination and per-key rate limits.
• 64 operations in total, described in the API reference and the OpenAPI document.

• API referenceEvery operation in v1.
• QuickstartSend a first message in a few minutes.