WhatsApp
Send Template Message
Send a WhatsApp message using an approved template
POST
This endpoint sends a WhatsApp message using a pre-approved template. Template messages are required when initiating a conversation with a user for the first time or when messaging outside the 24-hour messaging window.
This endpoint is rate-limited to 5 requests per second per user.
Request Body
The ID of the WhatsApp sender to send from (obtained from the Get Senders endpoint)
The ID of the message template to use (obtained from the Get Templates endpoint)
Key-value pairs for template variables. Keys should match the variable names from the template. If the template has variables
{{1}}, {{2}}, etc., provide them as {"1": "value1", "2": "value2"} or using the named keys from the template’s variables array.Response Fields
Error Responses
Notes
- Template messages must use approved templates. Templates with
pendingorrejectedstatus will fail. - The sender must be
online. Offline senders cannot send messages. - Message costs are automatically deducted from your account balance (credits for tenant users, minutes for direct users).
- After sending a template message, a 24-hour messaging window opens. During this window, you can send freeform messages without needing a template.
- If a conversation already exists with the recipient, the message is added to the existing conversation.
- Rate limit: 5 requests per second per user.

