Skip to main content
POST
/
send-link
Send link
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "message": "Check out our website: https://www.hubmessage.io",
  "image": "https://www.hubmessage.io/logo.png",
  "linkUrl": "https://www.hubmessage.io",
  "title": "Hub Message",
  "linkDescription": "Omnichannel API for Business Communication"
}
'
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
Overview

Method for sending messages with link preview, including image, title, and description.
Links are only clickable if the recipient has your number saved in their contacts or has previously started a conversation with you.
The response structure is identical to Z-API. Your existing code that processes these returns will continue working without changes.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Body

application/json
​
phone
string
required

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

Example:

"5511999999999"

​
message
string
required

Message text. Must include the link URL at the end

​
image
string
required

Link preview image URL

​
linkUrl
string
required

Link URL

​
title
string
required

Link title

​
linkDescription
string
required

Link description

​
linkType
enum<string>
default:SMALL

Preview size: SMALL, MEDIUM or LARGE

Available options:
SMALL,
MEDIUM,
LARGE
​
delayMessage
integer

Delay in seconds before sending (1-15)

Required range: 1 <= x <= 15
​
delayTyping
integer

Seconds to display "typing" status (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)