Skip to main content
POST
Reply to a conversation

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

The same as idempotency_key in the body. Send one or the other. Sending both returns 400.

Pattern: ^[A-Za-z0-9._:-]{1,120}$
Example:

"cancel-confirm-184532"

Path Parameters

conversation_id
integer
required

The conversation ID.

Required range: x >= 1

Body

application/json
body
string
required

The message, 1 to 5,000 characters after leading and trailing spaces are removed. An email reply uses the thread's subject. A text longer than 10 SMS segments returns 422.

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

One of the conversation's channels. Leave it out only when channels has exactly one of text and email.

Available options:
text,
email
idempotency_key
string

Scoped to the API key's creator and one conversation. A retry with the same idempotency key on the same conversation, from any API key that person created, returns the first message and sends nothing. Reusing the key with a different body or channel returns 409.

Pattern: ^[A-Za-z0-9._:-]{1,120}$

Response

The reply was accepted. Check delivery_status to see whether it went out. A retry with the same idempotency key returns the first message.

id
integer
required
Example:

7730514

conversation_id
integer
required
Example:

184532

from
enum<string>
required
Available options:
business
channel
enum<string>
required
Available options:
text,
email
Example:

"text"

text
string
required
Example:

"Hi Dana, your membership is cancelled and there is no charge on the 12th."

sent_at
string<date-time>
required
Example:

"2026-10-06T15:04:52.000Z"

delivery_status
enum<string>
required

queued means the carrier accepted the reply and has not sent it yet. failed means the send failed and error says why. unknown means the provider did not answer, so check the conversation later.

Available options:
queued,
sent,
delivered,
failed,
unknown
Example:

"queued"

error
string | null
required

A plain reason when the send failed. Otherwise null.

Example:

null