Skip to main content
POST
Queue a reply to an existing conversation

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Headers

Idempotency-Key
string
required

Stable key for one intended outbound operation. Reuse it only with an identical request.

Minimum string length: 1

Path Parameters

conversationId
string
required

Body

application/json
text
string
required
Maximum string length: 4096
mediaId
string

Existing Visito media asset for this conversation. Mutually exclusive with media.

replyToExternalMessageId
string
media
object

One remote attachment, available by default. Unsupported channel combinations are rejected without falling back to a text link. Visito downloads and stores the file asynchronously.

autoFreeze
object

Omit to inherit the business default. Off preserves an existing pause. Mode is recommended; enabled is retained only for legacy compatibility.

Response

Reply accepted and queued, not delivered

accepted
enum<boolean>
required
Available options:
true
replyId
string
required
conversationId
string
required
requestEventId
string
required
correlationId
string
required
status
enum<string>
required
Available options:
queued
acceptedAt
string<date-time>
required