Skip to main content
POST
Send an operator message into a conversation thread

Authorizations

x-api-key
string
header
required

Path Parameters

route_name
string
required

Body

application/json

The operator-send door's JSON body. thread_id and text are required and hold at least one non-whitespace character; the remaining fields are optional richer-send forms delivered alongside text. The schema attribute is suffixed to avoid shadowing a BaseModel member; the wire key stays schema via the alias.

Spec metadata only — the door parses this body at the HTTP edge.

text
string
required

The message text to send.

Minimum string length: 1
Pattern: \S
thread_id
string
required

The thread to send into, as the send door returned it.

Minimum string length: 1
Pattern: \S
address
string | null

On a linked person's aggregated thread, the person address to target; omitted, the target is the thread's newest record.

A trailing line composing an interactive message.

header
Header · object | null

A media header composing an interactive message.

location
Location · object | null

A shared map pin {latitude, longitude, name?, address?}.

media
Media · object[] | null

Display media items delivered alongside the text.

options
Options · object[] | null

Flat tappable option objects — reply or link actions.

schema
Schema · object | null

An ask-less form's answer schema; the channel renders text as the prompt.

sections
Sections · object[] | null

Titled groups of tappable reply rows — the sectioned options alternative.

template
Template · object | null

A pre-approved out-of-window template to deliver.

Response

Success.

data
ThreadMessageAck · object
required

The stored id of an operator message sent by hand into a thread.