WhatsApp · JSON Structure

Whatsapp Business Management Api Template Button Structure

TemplateButton from WhatsApp API

Type: object Properties: 8 Required: 2

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

Properties

type text url phone_number example flow_id flow_action navigate_screen

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-business-management-api-template-button-structure.json",
  "name": "TemplateButton",
  "description": "TemplateButton from WhatsApp API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "QUICK_REPLY",
        "URL",
        "PHONE_NUMBER",
        "COPY_CODE",
        "FLOW",
        "OTP",
        "CATALOG",
        "MPM"
      ],
      "example": "QUICK_REPLY"
    },
    "text": {
      "type": "string",
      "example": "Hello from WhatsApp!"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/image.jpg"
    },
    "phone_number": {
      "type": "string",
      "example": "+15551234567"
    },
    "example": {
      "type": "string",
      "example": "example_value"
    },
    "flow_id": {
      "type": "string",
      "example": "wamid.abc123"
    },
    "flow_action": {
      "type": "string",
      "example": "example_value"
    },
    "navigate_screen": {
      "type": "string",
      "example": "example_value"
    }
  },
  "required": [
    "type",
    "text"
  ]
}