WhatsApp · Schema

TemplateParameter

TemplateParameter from WhatsApp API

Properties

Name Type Description
type string
text string
payload string
coupon_code string
image object
video object
document object
location object
currency object
date_time object
View JSON Schema on GitHub

JSON Schema

whatsapp-cloud-api-template-parameter-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-parameter-schema.json",
  "title": "TemplateParameter",
  "description": "TemplateParameter from WhatsApp API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text",
        "image",
        "video",
        "document",
        "location",
        "currency",
        "date_time",
        "payload",
        "coupon_code"
      ],
      "example": "text"
    },
    "text": {
      "type": "string",
      "example": "Hello from WhatsApp!"
    },
    "payload": {
      "type": "string",
      "example": "example_value"
    },
    "coupon_code": {
      "type": "string",
      "example": "example_value"
    },
    "image": {
      "$ref": "#/components/schemas/MediaObject"
    },
    "video": {
      "$ref": "#/components/schemas/MediaObject"
    },
    "document": {
      "$ref": "#/components/schemas/DocumentObject"
    },
    "location": {
      "$ref": "#/components/schemas/LocationMessage"
    },
    "currency": {
      "type": "object",
      "properties": {
        "fallback_value": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "amount_1000": {
          "type": "integer"
        }
      }
    },
    "date_time": {
      "type": "object",
      "properties": {
        "fallback_value": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "type"
  ]
}