Skip to main content
A template message is sent by filling in an approved template with real content. The API call uses a components array to supply the values for each part of the template: header (optional), body (required), footer (optional), and buttons (optional). The template itself was pre-approved by Meta; the components just supply the variable values at send time.

​
Sending a template

​
Component types

Only include a component in the components array if that component exists in the template and has variables or dynamic values to fill in. A footer with no variables doesn’t need to appear in the array.

​
Language codes

Common values: en (English), en_us (English US), hi (Hindi). Use whatever code you set when creating the template.

​
Technical detail

  • template.name — exact name of the approved template (case-sensitive).
  • template.language.code — must match the language code set during template creation.
  • Button index — zero-based position of the button as defined in the template. If your template has 3 buttons, they are index “0”, “1”, “2”.
  • Header parameter types: image, document, video (for media headers) or text (for text headers with variables).

​
Reference image

Template structure diagram

A template message showing its four parts — header image, body text, footer text, and reply buttons.

​
Frequently asked

Use type: "template", give the template name and language.code, then pass a components array to fill in the dynamic values. See the payload above.
It’s how you supply real values at send time — header images, body variables, button URLs, coupon codes. Each entry targets one part of the template (header, body, or a specific button by index).
Add a { "type": "header", "parameters": [{ "type": "image", "image": { "link": "..." } }] } entry in components.
Add a button component with sub_type: "copy_code" and pass { "type": "coupon_code", "coupon_code": "YOUR_CODE" } in its parameters.

​
Gotchas & common mistakes

  • Wrong index on buttons — button components must use zero-based index matching the order buttons were defined in the template. Wrong index = API error.
  • Including a component not in the template — if your template has no header, don’t include a header component in the array; it will cause an error.
  • language.code mismatch — must exactly match the language used at template creation. "en" and "en_us" are different codes.
  • Sending outside a template — you can only send templates outside the 24-hour window. See The 24-hour window.