Home Schema Example JSON Schema

WhatsApp Template Components

Type: array

WhatsApp template components based on the documentation.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root Component

Component

Type: object

Individual component within a WhatsApp template.

 No Additional Properties

root Component anyOf item 0
Type: object

The following properties are required:

  • type
  • text
root Component anyOf item 1
Type: object

The following properties are required:

  • type
  • format
root Component anyOf item 2
Type: object

The following properties are required:

  • type
  • buttons

root Component type

Type

Type: enum (of string)

Whether it is a HEADER, BODY, FOOTER, or BUTTONS.

Must be one of:

  • "HEADER"
  • "BODY"
  • "FOOTER"
  • "BUTTONS"

root Component format

Format

Type: enum (of string)

The content type within the component.

Must be one of:

  • "TEXT"
  • "IMAGE"
  • "DOCUMENT"
  • "VIDEO"
  • "LOCATION"

root Component example

Example

Type: object

An example provided by WhatsApp.

root Component text

Text

Type: string

For text content.

Must be at least 1 characters long

root Component buttons

Buttons

Type: array of object

For CTA and quick reply buttons

 No Additional Items

Each item of this array must be:

root Component buttons buttons items
Type: object
No Additional Properties

root Component buttons buttons items type

Type

Type: enum (of string)

The button type.

Must be one of:

  • "QUICK_REPLY"
  • "URL"
  • "PHONE_NUMBER"
  • "VOICE_CALL"

root Component buttons buttons items text

Text

Type: string

Text to display for the button.

Must be at least 1 characters long

root Component buttons buttons items example

Example

Type: object

An example provided by WhatsApp.

root Component buttons buttons items url

URL

Type: stringFormat: uri

URL for URL button.

root Component buttons buttons items phone_number

Phone Number

Type: string

Phone number for PHONE_NUMBER buttons.

Must match regular expression: ^\+[\d]{5,}$