WhatsApp · JSON Structure

Whatsapp Business Management Api Message Template Structure

MessageTemplate from WhatsApp API

Type: object Properties: 8

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

Properties

id name status category language components parameter_format quality_score

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-message-template-structure.json",
  "name": "MessageTemplate",
  "description": "MessageTemplate from WhatsApp API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "wamid.abc123"
    },
    "name": {
      "type": "string",
      "example": "Example Business"
    },
    "status": {
      "type": "string",
      "enum": [
        "APPROVED",
        "PENDING",
        "REJECTED",
        "PAUSED",
        "DISABLED"
      ],
      "example": "APPROVED"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTHENTICATION",
        "MARKETING",
        "UTILITY"
      ],
      "example": "AUTHENTICATION"
    },
    "language": {
      "type": "string",
      "example": "en_US"
    },
    "components": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateComponentDefinition"
      }
    },
    "parameter_format": {
      "type": "string",
      "enum": [
        "POSITIONAL",
        "NAMED"
      ],
      "example": "POSITIONAL"
    },
    "quality_score": {
      "type": "object",
      "properties": {
        "score": {
          "type": "string"
        }
      }
    }
  }
}