Skip to main content
put/conversations/{conversation_id}/variables/{variable_id}
Request example
Response
put/conversations/{conversation_id}/variables/{variable_id}

Authorization

Authorizationstringheaderrequired#

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_idstringrequired#
ID of the conversation that owns the variable. Get conversation IDs from List Conversations.
variable_idstringrequired#
ID of the variable to update. Get variable IDs from List Conversation Variables.

Body

application/json
userstring#
End-user identifier, defined by your app and unique within it. See End User Identity.
valueanyrequired#
The new value for the variable. Must match the variable's expected type.

Responses

application/json
Variable updated successfully.
created_atinteger#
Creation timestamp.
descriptionstring#
Variable description.
idstring#
Variable ID.
namestring#
Variable name.
updated_atinteger#
Last update timestamp.
valuestring#
Variable value (can be a JSON string for complex types).
value_typestring#
Variable value type. Possible values: string, number, object, secret, file, boolean, array[any], array[string], array[number], array[object], array[file], array[boolean].