Update Workflow Step

Change a step in the workflow's draft: its name, whether it runs, its action, or its app version. Only the fields you send change. Send the revision you last read in If-Match; the response's meta.revision is the new one.

PUT

Path

Path parameters

stringrequired

The workflow's id.

stringrequired

The step's id, from List Workflow Steps.

Headers

Optional headers

stringrequired

Required. The draft revision you last read (the revision from Get Workflow Definition, or meta.revision from your last change). The change applies only if nobody changed the draft since: otherwise it answers 412 with the current revision in error.details.revision. Send it as a strong entity tag ("r_..."): a weak one (W/"...") never matches and answers 412. Without it the request answers 428.

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Body

Arguments

string

A new display name, or null for the default.

A new display name. null goes back to the name the editor gives the step.

boolean

true to skip the step on runs.

true turns the step off: runs skip it.

string

The new action id or slug.

The step's new action, by id or slug. Arguments the new action does not take are dropped, as in the editor. null clears the action.

string

latest, or a version number.

Move the step to this version of its app: latest, or a version number. The action must exist in it.

Response fields

idstring

The step's id. Stable across edits; never positional.

numbernumber

The number the editor shows for this step, in execution order. Null for a folder, which the editor does not number.

namestring

The step's display name.

appSlugstring

The app the step runs, or the built-in step type (iterate, ifElse, map, ...).

appVersionstring

The app version the step is pinned to. "0" for built-in step types.

actionIdstring

The app action the step runs. Null for a built-in step type.

functionIdstring

The function this step calls, for a function call step.

parentStepIdstring

The step this one sits inside (a loop, group, folder or if/else). Null at the top level.

slotstring

Where the step sits in its parent: steps (the top level), body (a loop, group or folder), then or else (an if/else lane).

steps
body
then
else

depthnumber

How deeply the step is nested. 0 at the top level.

isDisabledboolean

True when the step is turned off and runs skip it.

isConfiguredboolean

Whether the step passed the editor's validation (required values set, connection chosen). Null when it was never validated.