Messages

Send Message with Link Preview

Send a text message with a custom link preview card.

Home/Docs/Send Message with Link Preview

Endpoint

Send a text message with a custom link preview card.

Request

POST /sendLinkCustomPreview

Authentication

Every request must include a Bearer token in the Authorization header. Missing or invalid API keys return 401 Unauthorized.

Header

Authorization: Bearer YOUR_API_KEY

Request Body

Field	Type	Required	Description
session	string	Yes	Session ID
to	string	Yes	Recipient phone number
text	string	Yes	Message text containing the URL
preview	LinkPreview	Yes	Custom link preview object

Response

Field	Type	Description
id	string	Unique message identifier
to	string	Recipient phone number or group JID
content	string	Message content, media reference, or caption
type	string	Message type: text, image, video, document, or ptt
timestamp	string	ISO 8601 timestamp of when the message was sent
status	string	Delivery status such as sent, delivered, or read
fromMe	boolean	True when sent by the current session
sender	string	Sender phone number
recipient	string	Recipient identifier

Examples

cURL

curl -X POST "https://api.example.com/sendLinkCustomPreview" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "msg_128",
  "to": "+1234567890",
  "content": "https://example.com",
  "type": "text",
  "timestamp": "2026-04-15T10:00:00.000Z",
  "status": "sent",
  "fromMe": true,
  "sender": "+1234567890",
  "recipient": "+1234567890"
}

Notes

The text field must contain the URL being previewed.
preview.title is required; description and thumbnailUrl are optional.