Skip to main content
PATCH
Update ai chat
Required permissions:
  • ai_chat:update

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

ai_chat:update

Paramètres de chemin

id
string
requis

The unique identifier of the AI chat to update (e.g., "ai_chat_XXXXX").

Exemple:

"aich_xxxxxxxxxxxxx"

Corps

application/json

Parameters for UpdateAiChat

current_account_id
string | null

The unique identifier of the account to set as context for the AI chat (e.g., "biz_XXXXX").

notification_preference
enum<string> | null

The notification preference for the AI chat.

Options disponibles:
all,
none
title
string | null

The new display title for the AI chat thread (e.g., "Help with billing").

Réponse

A successful response

An AI-powered chat conversation belonging to a user, with optional scheduled automation.

agent_identifier
enum<string>
requis

The AI agent that handles this chat. Set when the chat is created and fixed for its lifetime.

Options disponibles:
general,
support
blended_token_usage
string
requis

The total number of tokens consumed across all messages in this conversation.

Exemple:

"123.45"

created_at
string<date-time>
requis

The datetime the ai chat was created.

Exemple:

"2023-12-01T05:00:00.401Z"

id
string
requis

The unique identifier for the ai chat.

Exemple:

"aich_xxxxxxxxxxxxx"

last_message_at
string<date-time> | null
requis

The timestamp of the most recent message in this conversation. Null if no messages have been sent yet.

Exemple:

"2023-12-01T05:00:00.401Z"

message_count
integer
requis

The total number of messages exchanged in this conversation.

Exemple:

42

notification_preference
enum<string>
requis

The notification preference for this AI chat. all delivers AI chat notifications and badges, while none mutes them.

Options disponibles:
all,
none
title
string | null
requis

A short descriptive title for this AI chat conversation. Null if no title has been set.

Exemple:

"Weekly Revenue Analysis"

updated_at
string<date-time>
requis

The datetime the ai chat was last updated.

Exemple:

"2023-12-01T05:00:00.401Z"

user
object
requis

The user who owns this AI chat conversation.