Skip to main content
POST
Send link with preview

Authorizations

Authorization
string
header
required

Instance token (zpfy_inst_...) — sends messages.

Body

application/json
to
string
required

Message recipient: a phone in E.164 (e.g. 5511999998888) or a WhatsApp id — the chat.id of a webhook, or a group id.

Example:

"5511999998888"

text
string
required

Text accompanying the link.

url
string<uri>
required

Target URL of the link (the preview is generated from it).

Example:

"https://zapfy.io"

title
string

Title shown in the link preview.

description
string

Description shown in the link preview.

imgUrl
string<uri>

Preview card image.

delay
integer

Optional delay in milliseconds before sending; WhatsApp shows "typing…" during this interval.

quoted
object

Quotes (replies to) a previous message.

Response

Send accepted. The message goes out right after, in the order you asked; the outcome arrives by webhook (MESSAGE.SENT, or MESSAGE.STATUS_UPDATED with status FAILED) and in GET /messages/{messageId}.

data
object

Identifier of the sent message. Store the messageId: together with the same to you sent to, it is what /messages/delete and /messages/edit need.