Skip to main content
POST
Send PIX button

Authorizations

token
string
header
required

Body

application/json
number
string
required

ID of the chat the message will be sent to. Can be a phone number in international format, a group ID (@g.us), a user ID (with @s.whatsapp.net or @lid).

Example:

"5511999999999"

pixType
string
required

PIX key type. Accepted values: CPF, CNPJ, PHONE, EMAIL or EVP

Example:

"EVP"

pixKey
string
required

PIX key value (CPF/CNPJ/phone/email/EVP)

Example:

"123e4567-e89b-12d3-a456-426614174000"

pixName
string

Name displayed as PIX receiver (default "Pix" if empty)

Example:

"Example Store"

async
boolean

Queues the sending for asynchronous processing

delay
integer

Delay in milliseconds before sending (displays "typing..." in WhatsApp)

readchat
boolean

Marks the chat as read after sending the message

readmessages
boolean

Marks recent messages as read after sending

replyid
string

ID of the message to be replied to

mentions
string

List of mentioned numbers separated by comma

track_source
string

Tracking source (e.g., chatwoot, internal-crm)

track_id
string

Tracking identifier (accepts duplicate values)

Response

PIX button sent successfully

Represents a message exchanged in the system

id
string<uuid>

Internal unique message ID (format r + 7 random hex characters)

messageid
string

Original message ID at the provider

chatid
string

Related conversation ID

sender
string

Message sender ID

senderName
string

Sender's display name

isGroup
boolean
default:false

Indicates whether it is a group message

fromMe
boolean
default:false

Indicates whether the message was sent by the user

messageType
string

Message content type

source
string

Message source platform

messageTimestamp
integer
default:0

Original message timestamp in milliseconds

status
string

Message lifecycle status. Common examples: Queued, Canceled, Failed, Sent, Delivered, Read. In group messages, it follows the most advanced participant: Delivered when at least one received it, Read when at least one read it, and Played when at least one listened to it.

text
string
default:""

Original message text

quoted
string
default:""

ID of the quoted/replied message

edited
string
default:""

Message edit history

reaction
string
default:""

ID of the reacted message

vote
string
default:""

Poll and list voting data

convertOptions
string
default:""

Conversion of message options, list, poll and buttons

buttonOrListid
string
default:""

ID of the selected button or list item

owner
string
default:""

Message owner

error
string
default:""

Error message if sending failed

content

Raw message content (serialized JSON or text)

wasSentByApi
boolean

Indicates whether the message was sent via API

pinned
boolean

Message pinned in the conversation (pin and unpin also arrive in messages_update, types Pinned and Unpinned)

sendFunction
string

Function used to send the message (when sent via API)

sendPayload

Payload used in the send when available. Base64 media data is omitted.

fileURL
string

Message file URL or reference

callPeer
object

Known contact associated with a call, when available in messageType: call.

send_folder_id
string

Folder associated with the send (when applicable)

track_source
string

Tracking source

track_id
string

Tracking ID (may repeat)

ai_metadata
object

Record of an AI round. The full one (request to the model, response, and outcome) is stored once, on the contact's last message that the round replied to, even when nothing went out (error, discarded response). Each message sent by the AI carries only agent_id and turn (the id of that contact message).

sender_pn
string | null

Sender's resolved PN JID (when available)

sender_lid
string | null

Sender's original LID (when available)

sender_image_preview_url
string<uri>

Temporary preview URL of the sender, when known. Hydration in this version fills in messages received in groups; the field may be omitted. It does not trigger a photo query to WhatsApp during listing.

response
object