// Workspace Variables

Update a workspace variable

Update workspace variable metadata.

PUT/api/workspace-variable

Description

Updates the variable definition. Pass only the fields to change.

Parameters

NameInTypeRequiredDescription
variableId body string yes ID of the workspace variable.
name body string no New name.
description body string no New description.
variableType body string no See below.

Variable types

variableType accepts Text, Secret, Script, Number, Boolean, Date, Map, and Json. Omit the field to leave the type unchanged.

Errors

StatusMeaning
400 Invalid variableId or validation failure.
401 Missing or invalid Basic auth credentials, or the service account lacks the required role.