Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingestion
/
whatsapp
/
v1
/
message
/
document
/
send
Send WhatsApp Document Message
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingestion/whatsapp/v1/message/document/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "recipient": "<string>",
  "phone_id": "<string>",
  "document": {
    "id": "<string>",
    "link": "<string>",
    "caption": "<string>",
    "filename": "<string>"
  },
  "post_back_url": "<string>",
  "post_back_data": "<string>"
}
'
{
  "status": true,
  "message": "WhatsApp document message sent successfully"
}

​
Description

This endpoint allows you to send a document message via WhatsApp. You can send documents by providing a media ID (for uploaded media) or a link to hosted media.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Body

​
recipient
string
required
The phone number of the recipient in international format (e.g., “919876543210”).
​
phone_id
string
required
The unique identifier associated with the sender’s phone number given by WhatsApp.
​
document
object
required
Document message object.
​
post_back_url
string
Optional URL to receive post-back notifications about the message status.
​
post_back_data
string
Optional data to include in post-back notifications.

​
Response

​
status
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
Success or error response message.
{
  "status": true,
  "message": "WhatsApp document message sent successfully"
}