Skip to main content
PATCH
Update status & outcome

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Path Parameters

id
string
required

The conversation id (conv_…).

Body

application/json

The body of an update-conversation request.

status
enum<string>
Available options:
open,
closed,
completed
outcome
string | null

A disposition key; null clears it.

Response

The updated conversation.

data
object

A conversation. messages + participants are present on retrieve/create and absent from list rows.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"