VUZDevelopers

Send document via WhatsApp

POST
/documents/{id}/share/whatsapp

Sends an issued document (PDF) to the customer via WhatsApp using the approved document_share_he_with template.

Requirements:

  • Document must be issued (not a draft — needs a document number)
  • A recipient phone (provided, or the document client's phone on file)
  • The WhatsApp template must be APPROVED in the registry

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Document ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/documents/550e8400-e29b-41d4-a716-446655440000/share/whatsapp" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "message": "חשבונית מס 1001 נשלחה בוואטסאפ בהצלחה! 📲",  "recipientPhone": "972527253023",  "docTypeName": "חשבונית מס",  "docNumber": "1001",  "whatsappMessageId": "wamid.HBgL..."}