Send document - Omni Z-API

In development. This endpoint does not exist yet. The page is published so you can get to know the shape and plan the integration — the body below is what will apply when it ships.

Overview

Sends a file to the contact. WhatsApp picks the icon from the extension and the name you provide. The content.type field will be DOCUMENT.

Request body

{
  "recipient": { "identifier": "5511999999999" },
  "content": {
    "type": "DOCUMENT",
    "attachments": [
      {
        "url": "https://yourstore.com/invoice.pdf",
        "fileName": "invoice.pdf",
        "caption": "Here is your invoice"
      }
    ]
  }
}

Rules

Rule	Value
Size	up to 100 MB
Types	PDF, Word, Excel, PowerPoint, text
Caption	up to 1024 characters
`fileName`	with the extension — it is what defines the icon the customer sees

The fileName goes with the extension, like invoice.pdf. There is a known defect in that field on the Z-API compatibility layer today: with the extension the file arrives as invoice.pdf.pdf, and without it it arrives as invoice.null.