Update a workflow variable

put/v1/workflow-variables/{id}
Requires any one of these rolesAbout roles
org.permission.workflow
Legacyorg.admin.workflow

The API key or user must hold at least one of them. Legacy roles still work; prefer the others for new keys.

Updates a workflow variable based on the Workflow Variable ID.

About this resource

Workflow variables

A workflow variable is a named value stored with one workflow, such as an API key or a URL that differs between sandbox and production. Steps can use it without the value being written into the workflow itself.

Anything written directly into a workflow's params is visible to everyone who can view workflows and is returned by GET /v1/workflows. Variables keep secrets and environment-specific values out of the document. Each variable belongs to exactly one workflow, so two workflows that need the same token each hold their own copy. A workflow whose trigger or steps reference a variable reports containsVariables: true.

Steps read a variable by its ID, not its name: /#variables.<variableId> in a param, or {{{variables.<variableId>}}} inside a template, for example in an Authorization header of a REST step. The ID is the 24-character id returned when you create the variable; a reference that uses the name resolves to nothing. Variables are removed from the run context that failed-run records store, so their values don't leak into error logs.

Values are write-only

Attribute Meaning
name A label for people; steps refer to the variable by its id. Letters, numbers, -, _ and ., up to 128 characters.
value The secret, 1 to 1,024 characters. Accepted on create and update, never returned.
maskedValue The last six characters of the value, so you can tell which key is stored.
type Always string.

Because the value can't be read back, keep the source of truth in your own secret store and write it to Kustomer when it changes. Workflows copied to another workflow or org don't bring their variables with them: create them again on the copy, then update every variable reference to the new IDs.

Which endpoint to use

To Call
List a workflow's variables GET /v1/workflows/{id}/variables
Add a variable to a workflow POST /v1/workflows/{id}/variables
Read, change or delete one variable GET, PUT or DELETE /v1/workflow-variables/{id}

Creating a variable needs name, value and type; PUT changes only the fields you send, so you can rotate a secret by sending just value. Variables are cached, so a new or changed value can take about a minute to reach new runs, just like workflow edits. When you create a workflow that depends on variables, create it disabled, add the variables, then enable it, so no run starts without them.

Path parameters

idstringrequired
Example "5b84680f6a3d70001b4c7183"

Request body

application/json
namestring
min length 1 · max length 128 · pattern ^[a-zA-Z0-9-_.]+$
valuestring
min length 1 · max length 1024
typestring
One of"string"

Responses

OK

objectrequired