Skip to main content
PUT
Set the custom status of a chat session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

The unique identifier of the chat session

Body

application/json
sub_status_id
string<uuid>
required

Id of the custom status to apply, from GET /custom-statuses

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
tags
object[]
required

All tags currently assigned to this session, ordered by tag name. Empty when no tags are assigned.

status
enum<string>
required
Available options:
open,
closed_resolved,
closed_unresolved
sub_status_id
string | null
required

Id of the custom status refining status, or null when only the built-in status applies. Resolve it with GET /custom-statuses.

ai_closure_type
enum<string> | null
required
Available options:
assumed_resolved,
handed_off,
resolved
sentiment
enum<string> | null
required
Available options:
angry,
happy,
neutral
summary
string | null
required

AI-generated summary of the conversation. Populated for both AI-resolved and handed-off sessions once the session has been summarized; null otherwise.

channel
object
required
assignee
object
required

Current session assignment. AI and unassigned sessions have no assignee ID.

support_team
object | null
required

Support team assigned to this session. Null when no team can be resolved within the session organization.

ticket_number
number
required
assist_mode
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
first_human_message_at
string<date-time> | null
required

Timestamp of the first recorded human reply to this session. Null when no human reply has been recorded.

contact
object
language
string
assignee_id
string | null
deprecated

Deprecated: use assignee. Contains the recorded human user ID as a string, or null for AI and unassigned sessions. Use assignee.type to distinguish them. This deprecation applies only to response fields; assignment requests still accept assignee_id.

custom_data
object

Session-level custom data stored on the chat session.

team
object
handoff
object
ticketing_system
object