Template

​

Request

​

Field types

• to: string (required)
• type: string = template (required)
• templateName: string (required)
• language: string (optional)
• variables: array of strings OR object with string values (optional)
• tags: array of strings (optional)
• metadata: object | string (optional)
• headerMedia: object (optional). Replaces the template header media for this message only. Only for templates whose header is an image, video or document.
  • link: string (required): public https URL of the file, max 2048 characters. The file must be reachable without authentication and respect WhatsApp size limits for its type.
  • filename: string (optional): display name for document headers (ignored for images and videos).

{
  "to": "+573001112233",
  "type": "template",
  "templateName": "order_update",
  "language": "es",
  "variables": ["Juan", "A123"],
  "tags": ["vip"],
  "metadata": { "source": "api" },
  "headerMedia": {
    "link": "https://cdn.example.com/invoices/A123.pdf",
    "filename": "invoice-A123.pdf"
  }
}

​

Header media errors

​

Response

{
  "data": {
    "messageId": "uuid",
    "status": "sent",
    "providerMessageId": "string"
  },
  "meta": {
    "timestamp": "2024-01-01T00:00:00.000Z",
    "mode": "sync"
  }
}