Send Template Message
Send an existing, approved template message to a recipient. You can provide dynamic variables, header media, and metadata about the recipient, and you can override predefined behaviors such as the action performed after the recipient replies.
Send template messages
Phone number formats: to is flexible - 0521234567, 972521234567, +972 52-123-4567 etc. are all accepted and normalized.
Unsubscribed recipients: if the recipient unsubscribed from template messages, the message is not sent and the API responds with HTTP 200, success: false and an explanatory error (e.g. "Recipient unsubscribed from template messages on ...").
All status values, type enums and the ID cheat sheet: Enums & Common Fields.Authorizations
API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.
Body
The template's unique name (ID) to send
^[a-zA-Z0-9_-]+$Recipient's phone number
The sender's WhatsApp account number. If not provided while multiple channels exist, the template is sent from the default channel
Template localization code to send (e.g. en, he). Auto-selected when the template has a single localization
Values for template body variables ({{1}}, {{2}}, ...) in order. Required if the template includes variables. Values must not contain line breaks, tabs, or 5+ consecutive spaces
Header media to use when sending (overrides the template default): type + url, plus filename for documents
Data to update on the chat when sending
Button payload values. Required if the template includes a variable in a URL button (inject the variable value) or was made with a Flow form. Non-English values for URL payloads should be URL-encoded
Defines behavior after the recipient replies (overrides the template defaults)
Attempt to send as a regular session message instead of a template when the 24-hour window is open (no template fee)
Groups individual API calls into a single entry in the Bulk Reports dashboard. Use a consistent title across multiple requests to aggregate their statistics under one report
1 - 255Replace the actual template parameters in the database with these values (useful for sensitive data like OTP codes)
If true, extra parameters in body are ignored instead of failing the request
Replace missing parameters with a single whitespace instead of failing
Skip validation (HEAD request) of header media URL accessibility
Skip sending entirely when the chat is currently in one of the given statuses
Skip applying the reply action when the chat is currently in one of the given statuses
Response
The result of the send operation. Note: an unsubscribed recipient also returns HTTP 200 but with success: false
Whether the template message was successfully sent
The final rendered message text after inserting all variable values
Whether the message was sent as a session message instead of a template message
Unique identifier of the message created in Texter
Error description, present when success is false