Skip to main content
POST
CLI
The reply is sent as the user who created the key, exactly like a reply typed in the inbox. Send "dryRun": true first to see the recipient, the subject, the WhatsApp window and the effects without sending.

Rules

  • WhatsApp 24-hour window. Free text only within 24 hours of the contact’s last WhatsApp message. Outside it the answer is 422 WHATSAPP_WINDOW_CLOSED and nothing is sent: use an approved template instead.
  • Email threading. Sent to the address of the contact’s last email (or the contact’s email) in the same email thread, from your workspace’s sender. The subject in the preview is the subject sent.
  • No double sends. The same text sent in the same thread in the last 10 minutes is not sent again: "sent": false with duplicateOf (the id of the message already sent).
  • Handover. A WhatsApp reply pauses the AI on this conversation and assigns it to the key’s user if nobody had it.

Permissions

The API key needs the Inbox permission. A key with no user (none created it) cannot reply.

Common Errors

Errors answer with the code in message and a sentence you can show in userMessage:

Authorizations

Authorization
string
header
required

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

Path Parameters

threadId
integer
required

The threadId from List Threads or Search Threads.

Body

application/json
text
string
required

Plain text.

Required string length: 1 - 4096
channel
enum<string>

Default: the channel of the contact's last WhatsApp or email message.

Available options:
whatsapp,
email
subject
string

Email only. Default: Re: <subject of their last email>.

Maximum string length: 300
dryRun
boolean

true = validate and return the preview, send nothing. A JSON boolean, not "true".

Response

Sent, previewed (dryRun), or skipped as a double send (duplicateOf)

data
object