Skip to main content
PATCH
For an existing protected thread, send its x-widget-thread-token capability in addition to widget identity. Widget identity is verified when signing is configured; tokenless compatibility does not establish tenant ownership. See the authentication and recovery guide for credential and retry rules.

Path parameters

string
required
Thread id (thr_<uuid>).

Headers

string
Capability required for an existing thread that has an issued token. Legacy capability-less threads are denied when STATESET_THREAD_TOKEN_REQUIRED=true.

Request body

ThreadUpdateRequest
string
Maximum length: 500.
string
Maximum length: 500.
object

Response

object
Thread
required
Thread as serialized for clients: server-only fields (state, accessToken, owner, restoredFromClientHistory) are stripped.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on November 13, 2026