Skip to main content
PATCH
Rename or archive a chat thread, or set its standing context

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

thread_id
string<uuid>
required

Body

application/json

Rename, archive or unarchive a thread. Omitted fields are left alone.

title
string | null

New title.

Required string length: 1 - 200
status
enum<string> | null

Archive or restore the thread.

Available options:
regular,
archived
instructions
string | null

Standing instructions for the assistant, as Markdown. Added to the base prompt, never replacing it, and added to rather than replacing any the workspace sets. Cannot change which tools exist or which need approval. Empty clears them.

Maximum string length: 4000
defaults
ChatContextDefaults · object | null

Replaces the pinned defaults; send an empty object to clear them.

Response

Successful Response

A chat thread as the thread list shows it, with what you may do with it.

id
string
required

Thread ID.

status
enum<string>
required

Active or archived.

Available options:
regular,
archived
created_at
string<date-time>
required

When the thread was created.

updated_at
string<date-time>
required

Last activity in the thread.

created_by
string
required

Who started the thread.

can_post
boolean
required

Whether you can send messages in it.

can_manage
boolean
required

Whether you can rename, archive or delete it.

can_share
boolean
required

Whether you can create share links for it.

title
string | null

Display title; null until the first message.

workspace_id
string | null

The workspace the thread belongs to; null for a personal thread.

instructions
string | null

Standing instructions for the assistant, as Markdown. Added to the base prompt, never replacing it, and added to rather than replacing any the workspace sets. Cannot change which tools exist or which need approval.

defaults
ChatContextDefaults · object

What the assistant reaches for first in this thread.

subject
ChatSubject · object | null

The item this thread is about, if it is bound to one.