Skip to main content
Use POST /v1/whatsapp/messages/document for invoices, statements, and PDFs. Point at a publicly reachable media_url; WhatsApp fetches it at send time, so it must be reachable then and serve the correct Content-Type. Needs an open 24-hour window.

​
Endpoint

POST https://karibu.briq.tz/v1/whatsapp/messages/document
Headers: X-API-Key (required), Content-Type: application/json.

​
Fields

FieldTypeRequiredNotes
media_urlstringone sourcePublic HTTPS URL to the document.
file_idstringone sourceUploaded media id (first-party). Use media_url for external integrations.
filenamestringnoRecommended — the name and icon shown to the recipient, e.g. Invoice-A1234.pdf.
captionstringnoOptional, up to 1024 characters.
to + sender—targetCustomer number (E.164) and which of your numbers to send from. sender is optional when you have one active number.
conversation_iduuidaltAlternative to to + sender: an existing thread to reply in.

​
Constraints

FormatsPDF, Word (.doc/.docx), Excel (.xls/.xlsx), plain text (.txt)
Max size100 MB

​
Example

cURL
curl -X POST "https://karibu.briq.tz/v1/whatsapp/messages/document" \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{ "to": "255712345678", "media_url": "https://example.com/invoice.pdf", "filename": "Invoice-A1234.pdf", "caption": "Your invoice" }'
Returns 202 { message_id, status: "pending" }. Then track delivery. Build and send a live request from the Send a document reference page.