WhatsApp · Schema

DocumentObject

DocumentObject from WhatsApp API

Properties

Name Type Description
id string Media ID from upload
link string HTTPS URL of the document
caption string Caption text
filename string Filename to display to recipient
View JSON Schema on GitHub

JSON Schema

whatsapp-cloud-api-document-object-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-document-object-schema.json",
  "title": "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"
    }
  }
}