WhatsApp · JSON Structure

Whatsapp Cloud Api Template Component Structure

TemplateComponent from WhatsApp API

Type: object Properties: 4 Required: 1

TemplateComponent is a JSON Structure definition published by WhatsApp, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type sub_type index parameters

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whatsapp/refs/heads/main/json-structure/whatsapp-cloud-api-template-component-structure.json",
  "name": "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"
  ]
}