WhatsApp · JSON Structure

Whatsapp Cloud Api Text Message Structure

TextMessage from WhatsApp API

Type: object Properties: 2 Required: 1

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

Properties

body preview_url

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-text-message-structure.json",
  "name": "TextMessage",
  "description": "TextMessage from WhatsApp API",
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "Message text",
      "maxLength": 4096,
      "example": "Hello from WhatsApp!"
    },
    "preview_url": {
      "type": "boolean",
      "description": "Set true to render URL previews",
      "default": false,
      "example": true
    }
  },
  "required": [
    "body"
  ]
}