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

​
Overview

Method responsible for sending a link to your contacts, widely used to share links so users are directed to a website.
It’s important to know that the link only becomes clickable if the recipient already has your phone number saved in their contacts, or if they have initiated a conversation with you.

​
Attributes

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

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999. IMPORTANT Send only numbers, without formatting or masks
​
message
string
required
Text about your link. Don’t forget to include the same linkURL value at the end of this text.
​
image
string
required
Image link
​
linkUrl
string
required
Your link URL
​
title
string
required
Link title
​
linkDescription
string
required
Link description

​
Optional

​
linkType
string
Attribute used to define the size of the link preview message (SMALL, MEDIUM or LARGE). The default size if not provided is SMALL.
​
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
​
delayTyping
number
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will show “Typing…” status. The default delay if not provided is 0

​
Request Body

{
  "phone": "5511999998888",
  "message": "Here you write text about the site, attention this text needs to have the link that will be sent at the end of the message! Like this: https://z-api.io",
  "image": "https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
  "linkUrl": "https://z-api.io",
  "title": "Z-API",
  "linkDescription": "WhatsApp integration"
}

​
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”.