WhatsApp · JSON Structure

Whatsapp Cloud Api Document Object Structure

DocumentObject from WhatsApp API

Type: object Properties: 4

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

Properties

id link caption filename

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-document-object-structure.json",
  "name": "DocumentObject",
  "description": "DocumentObject from WhatsApp API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Media ID from upload",
      "example": "wamid.abc123"
    },
    "link": {
      "type": "string",
      "format": "uri",
      "description": "HTTPS URL of the document",
      "example": "example_value"
    },
    "caption": {
      "type": "string",
      "description": "Caption text",
      "example": "example_value"
    },
    "filename": {
      "type": "string",
      "description": "Filename to display to recipient",
      "example": "Example Business"
    }
  }
}