Skip to main content
PATCH
Update Chat State

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

chat_id
string
required

Chat ID

Body

Schema for updating chat state

state
enum<string>

The state status of the chat

Available options:
OPEN,
SNOOZED,
CLOSED
ai_enabled
boolean

Whether AI is enabled for the chat

assistant_config
object

Schema for the configuration of an assistant

follow_up_at
string<date-time> | null

Scheduled follow-up datetime (set null to cancel)

muted_until
string<date-time> | null

Mute the chat until this datetime (set null to clear). Max 1 year in the future.

csat_score
integer | null

Customer satisfaction score (1-5)

Required range: 1 <= x <= 5

Response

200 - application/json
id
string
required
title
string | null
required

The title of the chat

model
string
required

The model used for the chat

members
object[]
required

The members of the chat

temporary
boolean
required

Whether the chat is temporary and would be deleted after 24 hours of last activity

visibility
enum<string>
required

The visibility of the chat

Available options:
PRIVATE,
PUBLIC_READ,
PUBLIC_WRITE
pinned
boolean
required

Whether the chat is pinned in the user interface

status
enum<string>
required

The status of the chat

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED
shared_url
string | null
required

The shared URL of the chat, if it is shared

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
tools
object[]

The tools available in the chat

skills
object[]

The skills enabled in the chat

features
object

Per-chat features and run settings: model features plus approval mode, auto-discover, and org-chat tool toggles.

org_id
string
state
object

Schema for the chat state

The link to the chat in the integration

last_message
object

The chat message schema

referral
object

Referral/commerce event data from Meta platforms — ads, products, orders.