Skip to main content
POST
Send a reply to a customer

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Headers

Idempotency-Key
string
required
Required string length: 8 - 255

Path Parameters

conversationId
string
required

Body

application/json
body
string

Reply text; required unless attachments are provided.

internal
boolean
default:false

Store an internal note without customer delivery.

sendAt
string<date-time>

Optional future email delivery time, at most 30 days ahead.

attachments
object[]

Durable /api/media references owned by this workspace; arbitrary URLs are not accepted for sending.

Response

Reply recorded; inspect queued and message.metadata.deliveryStatus for delivery state.

message
object
required

Every key is always present; optional fields are null when unset.

queued
boolean
required

True only when provider delivery has been durably queued.

undoMsec
integer
required

Normal undo window in milliseconds; zero for scheduled or unqueued replies.

scheduledFor
string<date-time>