WhatsApp · Schema

TemplateComponent

TemplateComponent from WhatsApp API

Properties

Name Type Description
type string
sub_type string Required for button components
index string Button index (required for button components)
parameters array
View JSON Schema on GitHub

JSON Schema

whatsapp-cloud-api-template-component-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whatsapp/refs/heads/main/json-schema/whatsapp-cloud-api-template-component-schema.json",
  "title": "TemplateComponent",
  "description": "TemplateComponent from WhatsApp API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "header",
        "body",
        "button"
      ],
      "example": "header"
    },
    "sub_type": {
      "type": "string",
      "enum": [
        "quick_reply",
        "url",
        "copy_code",
        "flow",
        "catalog"
      ],
      "description": "Required for button components",
      "example": "quick_reply"
    },
    "index": {
      "type": "string",
      "description": "Button index (required for button components)",
      "example": "example_value"
    },
    "parameters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateParameter"
      }
    }
  },
  "required": [
    "type"
  ]
}