Skip to main content
PUT
Update Conversation Variable

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

conversation_id
string<uuid>
required

ID of the conversation that owns the variable. Get conversation IDs from List Conversations.

variable_id
string<uuid>
required

ID of the variable to update. Get variable IDs from List Conversation Variables.

Body

application/json
user
string
required

End-user identifier, defined by your app and unique within it. Must match the user the conversation was created with. See End User Identity.

Required string length: 1 - 255
value
any
required

New value: null, a string, a number, a boolean, an object, or an array, matching the variable's declared type.

Response

The updated variable.

id
string

Conversation variable ID.

name
string

Variable name.

value_type
string

Declared type: string, number, boolean, secret, object, file, none, or an array type such as array[string], array[number], array[object], array[file], array[boolean], array[any].

value
string | null

String variables come back as-is; other types come back as a canonical JSON string; none comes back as null.

description
string | null

Variable description.

created_at
integer

Creation time as a Unix timestamp in seconds.

updated_at
integer

Last-update time as a Unix timestamp in seconds.