Update session metadata

Asynchronously updates metadata on a session. The update is applied via a
session_updated event — the response is immediate but the change may take
a moment to propagate.

Use this endpoint to mark a session as a lead, record success/failure, add a
comment, or set other outcome fields after the conversation ends.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Session UUID

Body Params

Fields to update on a session. All properties are optional — only provided
fields are updated.

string

Type or category label for the session

boolean

Mark this session as a test session (excluded from production metrics)

string

Description of the expected outcome, for QA and review purposes

boolean | null

Whether the session achieved its goal (null = unreviewed)

boolean

Flag this session as a captured lead

string

Free-text note or comment about the session

number | null

Penalty applied to the conversation quality score

boolean

Flag this session for follow-up action

boolean

Archive this session to remove it from active views

number

Estimated monetary value of this lead

boolean

Flag this session as a sales opportunity

number

Human-rated agent success score (0–1 scale)

Responses
200

Session update event queued successfully

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json