Create a template

Creates a WhatsApp template.

Body Params
string
required

WhatsApp Business Account ID.

string
required
length ≤ 512

Name of the template.

string
required

Language code of the template. See Supported Languages for all codes.

string
enum
required

Category of WhatsApp templates.

  • AUTHENTICATION: Enable businesses to authenticate users with one-time passcodes, potentially at multiple steps in the login process (e.g., account verification, account recovery, integrity challenges).
  • MARKETING: Include promotions or offers, informational updates, or invitations for customers to respond / take action. Any conversation that does not qualify as utility or authentication is a marketing conversation.
  • UTILITY: Facilitate a specific, agreed-upon request or transaction or update to a customer about an ongoing transaction, including post-purchase notifications and recurring billing statements.
Allowed:
string
enum

Subcategory of WhatsApp templates.

  • ORDER_STATUS: Order status template is categorized as UTILITY template and apart from name and language of choice, it has general template components such as BODY, FOOTER and additionally subcategory as ORDER_STATUS.
Allowed:
int32

If we are unable to deliver a message for an amount of time that exceeds its time-to-live, we will stop retrying and drop the message. By default, messages that use an authentication template have a default TTL of 10 minutes, and messages that use a utility or marketing template have a default TTL of 30 days. Set its value between 30 and 900 seconds (i.e., 30 seconds to 15 minutes) for authentication templates, or 30 and 43200 seconds (i.e., 30 seconds to 12 hours) for utility templates, or 43200 and 2592000 seconds (i.e., 12 hours to 30 days) for marketing templates. Alternatively, you can set this value to -1, which will set a custom TTL of 30 days for either type of template. We encourage you to set a time-to-live for all of your authentication templates, preferably equal to or less than your code expiration time, to ensure your customers only get a message when a code is still usable. Authentication templates created before October 23, 2024, have a default TTL of 30 days.

components
array of objects
required
components*
boolean

Optional. Indicates if template button click tracking is disabled. Set to true to disable button click tracking on the template, or false to enable. You can disable button click tracking on an individual template by setting this field to true. Once disabled, button engagement/clicks will not be displayed in the WhatsApp Manager when viewing the template's insights. If not provided, this value defaults to false, which means button click tracking is enabled by default.

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json