Skip to main content
PATCH
Update a thread

Authorizations

Authorization
string
header
required

Access token from POST /management/v1/auth/token (publishable-key exchange) or a login session. Publishable-key tokens are agent-scoped and serve the messaging surface; login tokens also serve management.

Path Parameters

threadId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

Partial update of a thread. Only title is updatable for now; every field is optional so future updatable fields stay additive (PATCH semantics).

title
string | null

New thread title; omit to leave the title unchanged.

Minimum string length: 1

Response

Successful Response

id
string
required

Thread id

Pattern: ^[0-9a-fA-F]{24}$
title
string
required

Thread title

user_id
string | null

End-user this thread belongs to, if any

welcome_message
string | null

Agent's opening message

followup_suggestions
string[] | null

Suggested follow-up prompts