Skip to content

Reply To Whatsapp Conversation

POST
/inbox/whatsapp/conversations/{chat_id}/reply

SENDS A WHATSAPP MESSAGE TO A REAL PERSON from the number that owns the chat.

Classified external (inbox:run). Refused BEFORE anything is sent when the contact opted out: 409 contact_opted_out, or 503 opt_out_unverified when the opt-out ledger cannot answer. Send a stable client_message_id so a retry of the same reply never sends twice.

Authorizations

Parameters

Path Parameters

chat_id
required

WhatsApp chat id.

string

WhatsApp chat id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A reply into an existing WhatsApp conversation. THIS SENDS A MESSAGE.

object
account_id
Any of:
string
client_message_id
Any of:
string
<= 188 characters
text
required

The message. Must not be blank.

string
>= 1 characters <= 4096 characters

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string