Skip to main content
The Pro Plus WhatsApp API lets you discover active connectors, inspect approved Meta templates, and send template messages to one or many recipients.

Base URL

The WhatsApp API uses the same base URL as the SMS API:
All WhatsApp endpoints use the following route prefix:

Quick start

1

Set up authentication

Use your client ID as the HTTP Basic username and your API key as the password.
2

Choose an active connector

List your active connectors and copy the connector’s phoneNumber and whatsappBusinessAccountId.
3

Find an approved template

List templates for the WhatsApp Business Account and copy the template’s metaTemplateId.
4

Send a message

Use a bulk payload when all recipients receive the same values, or a custom payload for per-recipient personalization.

Message capabilities

Bulk payloads

Send one set of template variables to a comma-separated recipient list.

Custom payloads

Supply different header and body values for each recipient.

Media and locations

Send approved templates with image, video, PDF, or location headers.

Carousel cards

Populate media, body variables, and dynamic URL values for each template card.
Messages must use a template already associated with the authenticated WhatsApp Business Account. A template that is pending or rejected cannot be sent.

Naming conventions

Request field names are case-sensitive. In particular, the API contract spells the recipient field RecieverNumber. Use that spelling exactly, even though ReceiverNumber is the conventional English spelling.