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

Request body for updating a conversation variable.

value
any
required

The new value for the variable. Must match the variable's expected type.

user
string

End-user identifier, defined by your app and unique within it. See End User Identity.

Response

Variable updated successfully.

id
string<uuid>

Variable ID.

name
string

Variable name.

value_type
string

Variable value type. Possible values: string, number, object, secret, file, boolean, array[any], array[string], array[number], array[object], array[file], array[boolean].

value
string

Variable value (can be a JSON string for complex types).

description
string

Variable description.

created_at
integer<int64>

Creation timestamp.

updated_at
integer<int64>

Last update timestamp.