Skip to main content
Sends a WhatsApp message using an approved template. Template messages are required when initiating a new conversation or messaging outside the 24-hour session window.
This endpoint is rate-limited to 5 requests per second per user.

Endpoint

POST /user/whatsapp/send

Request

integer
required
ID of the WhatsApp sender to send from. Use the Get senders endpoint to retrieve available senders.
integer
required
ID of the approved message template to use.
string
required
Recipient’s phone number in international format (e.g., +1234567890).
string
Recipient’s name for conversation tracking. Maximum 255 characters.
object
Key-value pairs for template variables. Keys should match the variable names in your template.

Response

boolean
Whether the message was sent successfully.
integer
ID of the conversation (new or existing).
integer
ID of the conversation message record.
integer
ID of the WhatsApp message record.
string
Twilio message SID for delivery tracking.
string
Initial delivery status (e.g., queued, sent).

Example

200 Success
404 Sender not found
422 Template not approved
402 Insufficient balance
After a template message is sent successfully, a 24-hour messaging window opens. During this window you can send freeform messages without needing a template.