whatsappSendTemplateMessage
Send an approved WhatsApp message template to a customer, opening or continuing a conversation outside the 24-hour customer-service window.
Identify the recipient by conversationId, customerId, or a raw
recipient phone number. Identify the template by templateId or
templateName + language.
Side effects: Creates one outbound message per resolved recipient.
Errors: invalid/unapproved template, missing recipient, or missing params for template variables.
Auth · x-app-token · required permission conversationMessageAdd
Related: whatsappGetTemplates, whatsappGetMessageTemplateDetail, WhatsappMessageTemplateResponse, Authentication
whatsappSendTemplateMessage(integrationId: String!, conversationId: String, customerId: String, recipient: String, recipientName: String, templateId: String, templateName: String, language: String, params: JSON, statusOnCreate: String): [WhatsappMessageTemplateResponse]Arguments
Sending WhatsApp integration id. Required.
Existing inbox conversation to attach the message to. Alternative to customerId / recipient.
Core customer id to resolve the recipient phone from. Alternative to conversationId / recipient.
Raw destination phone number (E.164). Alternative to conversationId / customerId.
Display name to store for a newly created contact, when sending to a raw recipient.
Meta template id. Alternative to templateName + language.
Template name. Use together with language when templateId is not known.
Template locale code (e.g. en_US). Required when identifying by templateName.
Values for the template's variable placeholders (header/body/button), shaped
to match the template's components from whatsappGetMessageTemplateDetail.
Optional initial conversation status to set if a new conversation is created.