Skip to main content
POST
/
messages
/
link
curl --request POST \
  --url https://wsapi.chat/messages/link \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "text": "Check this link",
  "url": "https://example.com/article"
}
'
{
  "id": "01234567890123456"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
​
to
string
required
​
text
string
required

Message text accompanying the link

​
url
string<uri>
required

URL to preview

​
title
string

Link preview title

​
description
string

Link preview description

​
jpegThumbnail
string

Base64-encoded JPEG thumbnail for preview

​
mentions
string[]
​
replyTo
string
​
replyToSenderId
string
​
isForwarded
boolean
​
ephemeralExpiration
enum<string>
Available options:
off,
24h,
7d,
90d

Response

Resource created

​
id
string

ID of the created resource