Skip to main content
POST
/
{instance}
/
send-link-custom-preview
cURL
curl --request POST \
  --url https://app.hypersender.com/api/whatsapp/v1/{instance}/send-link-custom-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chatId": "[email protected]",
  "text": "Check this out! https://hypersender.com/",
  "reply_to": "string",
  "high_quality": true,
  "preview_title": "Hypersender is awesome",
  "preview_description": "Check this out, this is a custom link preview!",
  "preview_url": "https://hypersender.com/",
  "preview_image_url": "https://m.media-amazon.com/images/M/MV5BMjRhYjdkOGMtZDY5Zi00OWEwLTlkOWEtYz.jpg"
}
'
{
  "key": {
    "remoteJid": "[email protected]",
    "fromMe": true,
    "id": "3EB091A456D98511123FEA"
  },
  "message": {
    "extendedTextMessage": {
      "text": "Check this out! https://hypersender.com/",
      "matchedText": "https://hypersender.com/",
      "description": "Check this out, this is a custom link preview!",
      "title": "Hypersender is awesome",
      "previewType": "NONE",
      "jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wAARCAARACADASIAAhEBAxEB/8QAGgAAAgIDAAAAAAAAAAAAAAAAAAUDBAECBv/EACwQAAECBQIEBAcAAAAAAAAAAAECAwAEBREhBjESEzVBYYGDsTI0UXJ0srP/xAAWAQEBAQAAAAAAAAAAAAAAAAABAAL/xAAXEQEBAQEAAAAAAAAAAAAAAAAAARIC/9oADAMBAAIRAxEAPwBi2HEqaUEXTY54hEEjVF1MOrTLqa5V0pJVnfe0Y1CX6fLS77E206gLIIbTw2NsE2ORviI9OzQmWVNKfQ282LhAbCisdzDehI3VU3kVBEutlTbjgt8YORkeREQ1GvKp86gusp5YBTw8YVfxt4WitW5GWS4h+cfcUt10qBKSjt9ADsIpT7NOm5d0tVdgu9kKSc22AO/naDRzDjUHRXPuT7wr0v8ANzH459xBBGSdDqFK9b+cclpjrvpPfoYIIoa//9k=",
      "thumbnailDirectPath": "/o1/v/t24/f2/m232/AQMNFP0XcTmGZckNL1WI6_-o4AAzaPTlTtqRat-YC7SlRrlpV8e_0fmUj7xBK5kS_9m4B-3wgG8wJ-aitI6TQqAXSTHEUhH5u4m1QCxRmw?ccb=9-4&oh=01_Q5Aa2gFW4du4I6OfD9Y_djyP1KIukQnFQRfu8YEfQJ6ydbY8JQ&oe=68F20A99&_nc_sid=e6ed6c",
      "thumbnailSha256": "KccP5I7AxrmcoUeD868qd0ISDFf6TYUTtw6dJS/Sdjk=",
      "thumbnailEncSha256": "Vveij+Avc8amAa2u6AtPSZG/07FzjJfDtMJqmYt/g4A=",
      "mediaKey": "Tp1eSebY/WJr+mZmzWmbRAj4WXyEmGsvSKZySAw9Kj8=",
      "mediaKeyTimestamp": 1758105918,
      "thumbnailHeight": 649,
      "thumbnailWidth": 1200
    }
  },
  "messageTimestamp": "1758105918,",
  "status": "PENDING"
}
This feature is only available for subscribed accounts.
Using send-text or send-text-safe you can send auto-generated link previews.

​
Provide a URL for the image.

send link custom preview url preview
WhatsApp requires the text to contain the preview URL anywhere in the text.Example: "text": "Check this out! https://hypersender.com/"
Please note that the URL must be publicly accessible and not require any authentication or special headers to access the file.

​
Send the image it self as a file upload.

send link custom preview file
By specifying the high_quality parameter as true, you can get a higher quality image.
send link custom preview preview

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept
string
Example:

"application/json"

​
Content-Type
string
Example:

"application/json"

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Body

application/json
​
chatId
string
required

Contact number - learn what is chatId

Example:

"[email protected]"

​
text
string
required

text should contain the url to send

​
preview_title
string
required

title of the link preview

​
preview_description
string
required

description of the link preview

​
preview_url
string
required

must be a valid URL

​
preview_image_url
string
required

URL of the image to be used in the link preview - (only if preview_image_file is not provided)

​
preview_image_file
string
required

file of the image to be used in the link preview - (only if preview_image_url is not provided)

​
reply_to
string

reply to message id

​
high_quality
boolean

high quality for the image

Response

Successful response

​
key
object
​
message
object
​
messageTimestamp
string
​
status
string