Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-document
/
{extension}
Send document
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-document/{extension} \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "document": "<string>"
}
'

​
Overview

Method responsible for sending documents to your contacts, it is simple and straightforward. You can work with documents in 2 ways:
  • By Link: if you have the document hosted somewhere on the internet, just send the link;
  • By Base64: if you want to send the document in Base64 format.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
extension
string
required
File extension being sent (e.g.: pdf, xlsx, docx)

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
document
string
required
Document link or Base64

​
Optional

​
fileName
string
Document display name
​
caption
string
File description
​
messageId
string
Attribute used to reply to a chat message, just add the messageId of the message you want to reply to
​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec
​
editDocumentMessageId
string
Allows editing the description of a previously sent document through the caption field. Webhook configuration is required before use

​
Request Body

By link: 
{
  "phone": "5511999999999",
  "document": "https://expoforest.com.br/wp-content/uploads/2017/05/example.pdf",
  "fileName": "My PDF"
}
By Base64: 
{
  "phone": "5511999999999",
  "document": "data:application/pdf;base64,JVBERiN0YXJ0eHJlZg0KMjg3NDINCiUlRU9G0xLj...",
  "fileName": "My PDF"
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.