Create message template

createWhatsAppMessageTemplate creates a template on the connected WhatsApp Business Account. Meta must approve the template before you use it with sendWhatsAppTemplateMessage.

automations/create-whatsapp-template.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { createWhatsAppMessageTemplate } from "automate.ax/whatsapp"

export default automation("Create pickup template", () => {
  onHttpRequest({ scope: "automation" })

  createWhatsAppMessageTemplate({
    templateName: "order_ready",
    languageCode: "en_US",
    category: "utility",
    header: {
      format: "text",
      text: "Order {{1}}",
      variableExamples: ["A-123"],
    },
    body: "Your order {{1}} is ready for pickup.",
    bodyVariableExamples: ["A-123"],
    footer: "Reply for support.",
    buttons: [
      {
        type: "url",
        text: "Track order",
        url: "https://example.com/orders/{{1}}",
        variableExample: "https://example.com/orders/A-123",
      },
    ],
  })
})

templateName, languageCode, category, and body are required. The name must contain only lowercase letters, numbers, and underscores. category is "utility" or "marketing". Body variable examples correspond to {{1}}, {{2}}, and later variables in order. Provide exactly one example per distinct body variable, or omit bodyVariableExamples when the body has no variables. A header can contain text, a Meta media example handle for an image, video, or document, or a location. Buttons support quick replies, phone numbers, and URLs. allowCategoryChange defaults to true, allowing Meta to recategorize the template instead of rejecting an otherwise valid submission. account selects the WhatsApp binding. Returns { templateId, category, status }. The initial status is commonly pending; Meta can also immediately approve or reject a template. Creating the template does not send a message.

Get started

Concepts

Reference

Create message template