MessagingWhatsAppTemplateRequest

A WhatsApp template the practice writes, to create one or to replace one with. Meta's rules are checked before it
is submitted: name 1–100 characters; body 1–1024 characters with placeholders {{1}}, {{2}}… numbered from 1 with no
gaps, not at the start or end and never two with only white space between them; one non-empty sample (at most 200
characters) per placeholder and none extra; language xx or xx_XX. A broken rule is a 400 with field errors
(friendlyName, language, category, body, samples, samples.{n}).

Properties

Name Type Description
friendlyNamestring

Its name, 1 to 100 characters

Its name, 1 to 100 characters

languagestring

Its language, xx or xx_XX (en, en_GB); en_GB when absent

Its language, xx or xx_XX (en, en_GB); en_GB when absent

categoryenum

Utility Marketing

Utility Marketing

bodystring

The text, with numbered placeholders, e.g. "Hello {{1}}, we have a message for you about {{2}}."

The text, with numbered placeholders, e.g. "Hello {{1}}, we have a message for you about {{2}}."

samplesobject

One example value per placeholder, keyed by its number ({"1": "Jane"}): Meta reviews the template with them

One example value per placeholder, keyed by its number ({"1": "Jane"}): Meta reviews the template with them

JSON Example

{
  "friendlyName": "string",
  "language": "string",
  "category": "Utility",
  "body": "string",
  "samples": {}
}

Used By Operations