Skip to main content
POST
/
send-document
/
{extension}
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-document/{extension} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "document": "https://example.com/file.pdf",
  "fileName": "My document"
}
'
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
Overview

Method for sending documents. The file extension must be specified in the URL path (e.g., /send-document/pdf). You can send via URL or Base64.
When sending as Base64, you must include the prefix with the document type, for example: data:application/pdf;base64,.
The response structure is identical to Z-API. Your existing code that processes these returns will continue working without changes.
File size limits and supported formats follow WhatsApp policies. See the official WhatsApp documentation for details.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Path Parameters

​
extension
string
required

File extension (e.g. pdf, docx, xlsx)

Example:

"pdf"

Body

application/json
​
phone
string
required

Recipient phone number (country code + area code + number)

Example:

"5511999999999"

​
document
string
required

Document URL or Base64 data

​
fileName
string

File name

​
caption
string

Document description

​
messageId
string

ID of an existing message to reply to

​
delayMessage
integer

Delay in seconds before sending (1-15)

Required range: 1 <= x <= 15

Response

Message sent successfully

​
zaapId
string

Internal identifier

​
messageId
string

WhatsApp message ID

​
id
string

Same value as messageId (compatibility)