Input Variables
Update Input Variable
Update a User Defined input variable’s type/description, or soft-delete it by passing status = 2. System variables cannot be modified, and deleting a variable that is still in use by an agent or audience is blocked.
POST
Update input variable
Use this endpoint to update or soft-delete a User Defined input variable.
When
Endpoint
POST/input-variable/update
Content-Type: application/json
Authentication: Required (workspace auth)
Request Body
Update fields
Soft-delete a variable
Response
status: 2 is sent:
Behavior
- Only User Defined variables can be updated — System variables always fail with
System variables cannot be modified. variable_keyis accepted in the request but is immutable and never applied — renaming a key would break every audience and agent that references it.- Passing
status: 2soft-deletes the variable (STATUSis set to2; it no longer appears in List Input Variables). Deleting is blocked while the variable is referenced by any agent or audience. - Editing
typeand/ordescriptionis allowed even while the variable is in use. The change is propagated into every agent flow that references the variable by key — the matchingmetadata_inputentry’stype/data_typeanddescriptionare updated in place. Audiences store variable keys only (no type/description), so they need no propagation. - Only the fields you send are applied; omitted fields are left unchanged.
Error Cases
Example cURL
Body
application/json

