Skip to main content
POST
/
v1
/
whatsapp
/
messages
/
document
Send a document
curl --request POST \
  --url https://karibu.briq.tz/v1/whatsapp/messages/document \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "to": "255712345678",
  "media_url": "https://example.com/invoice.pdf",
  "filename": "Invoice-A1234.pdf",
  "caption": "Your invoice"
}
'
{
  "success": true,
  "data": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender": "1107264639145282",
    "provider_message_id": "<string>",
    "status": "pending"
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "request_id": "<string>"
}
Send a document with an optional caption and filename. Provide media_url (a public HTTPS link) or file_id. WhatsApp fetches the URL at send time, so it must be reachable then and serve the correct Content-Type. Needs an open 24-hour window. Async: returns 202 { message_id, status: "pending" }.
Constraints — formats: PDF, Word (.doc/.docx), Excel (.xls/.xlsx), plain text (.txt). Max size: 100 MB. Set filename for the name and icon shown to the recipient.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
to
string

Recipient phone in E.164 digits (optional leading +), e.g. 255712345678. The number you are messaging. Pair with sender.

Required string length: 7 - 20
Pattern: ^\+?[1-9]\d{6,17}$
​
sender
string

Which of your WhatsApp numbers to send from (number or phone_number_id). Pair with to to target the conversation. Optional when your workspace has a single active sender. Preferred over sender_id.

Maximum string length: 64
​
conversation_id
string<uuid>

Alternative to sender. The id of an existing one-to-one thread; recipient and sender are taken from it, so to / sender / sender_id are ignored. Use this to pin a precise conversation when the same recipient can be reached through more than one of your senders.

​
sender_id
string<uuid>

Deprecated: use sender.

​
media_url
string

Publicly reachable media URL. Provide this or file_id.

​
file_id
string

Uploaded media file id (first-party). Provide this or media_url.

​
caption
string

Optional caption.

Maximum string length: 1024
​
filename
string

Filename shown to the recipient, e.g. invoice.pdf.

Maximum string length: 255

Response

Sent immediately (provider acknowledged).

​
success
boolean
​
data
object
​
errors
object[] | null
​
request_id
string