AirysChat icon

AirysChat

Consume AirysChat API

Actions3

Message → Send WhatsApp Template

AI-generated

Summary

Send a WhatsApp template message to a specified conversation

Inputs

  • inboxId (required) — WhatsApp inbox identifier or selection (options loaded via getInboxes)
  • conversationId (required) — ID of the conversation where the template will be sent
  • templateName (required) — Name or ID of the approved Meta WhatsApp template
  • templateLanguage (required) — Language code for the template (e.g., pt_BR, en_US)
  • mediaType — Type of media header if the template requires one (none, image, video, document)
  • mediaUrl — Public URL to the media file when mediaType is image, video, or document
  • bodyVariables — Variables to replace placeholders in the template body (multiple entries, each with index and value)
  • buttonVariables — Button definitions with payload/parameter and type (quick_reply or url)

Output shape

list of items each containing a json field with the API response

Returns the API response for each processed item; errors are captured as JSON objects if continueOnFail is enabled

Examples

Example 1: Send a simple text template to a conversation

inboxId selected, conversationId = 12345, templateName = "welcome_message", templateLanguage = "pt_BR", mediaType = "none", no body or button variables

Example 2: Send a template with image media and variables

inboxId selected, conversationId = 67890, templateName = "order_update", templateLanguage = "en_US", mediaType = "image", mediaUrl = "https://example.com/image.jpg", bodyVariables index=1 value="Order #123", buttonVariables parameter="confirm" type="quick_reply"

Links

Discussion