Actions2
- Message Actions
Message → Send Template
AI-generatedSummary
Send an approved WhatsApp Highly Structured Message (HSM) template to a recipient via phone number using the Hyperflow API. Construct the message payload by specifying the template name, language, variable parameters, optional header content (text, image, video, or document), and dynamic buttons as JSON arrays or strings.
Inputs
- Recipient Phone Number (required) — Phone number with country code (e.g., 5511999999999)
- Template Name (required) — Exact name of the approved HSM template registered in the WhatsApp Business Manager. Use lowercase letters and underscores.
- Template Language (required) — Language code of the template as registered with Meta, such as en_US, pt_BR, or es. Must match the approved template language.
- Template Parameters (JSON Array) — JSON array of values for the variable parameters within the template body, in order (e.g., ["John", "Order #123", "$99.90"]). Defaults to empty array if unspecified.
- Header Parameter — Variable parameter for a text header in the template, if it has one (e.g., replaces {{1}} in the header text). Leave empty if not applicable.
- Header Image URL — Publicly accessible URL for an image header in the template. Accepted formats: JPEG, PNG. Max size: 5 MB. Provide only if the template includes an image header.
- Header Video URL — Public URL for a video header in the template. Accepted format: MP4. Max size: 16 MB. Provide only if the template includes a video header.
- Header Document URL — Public URL for a document header (such as PDF, DOC, DOCX) in the template. Max size: 100 MB. Provide only if the template includes a document header.
- Template Buttons (JSON) — JSON array defining dynamic buttons with variable parameters for the template, e.g., URL buttons with dynamic query parameters or verification code buttons.
Output shape
a list of items, each containing the JSON response from the Hyperflow API corresponding to the sent template message for each input item
The operation processes all input items independently, returning successful responses or structured error objects for failures. Errors include detailed messages and respect the 'continue on fail' workflow setting.
Examples
Example 1: Send a WhatsApp template message with parameters and a header image
Set recipient phone number, template name exactly as registered, template language code, provide templateParameters JSON array with variable values, and supply a headerImageUrl pointing to a public JPEG or PNG image.