Add Workflow Step

Add a step to the workflow's draft. Changes apply to the draft only; publish to make them live. Send the revision you last read in If-Match; the response's meta.revision is the new one.

POST

Path

Path parameters

stringrequired

The workflow's id.

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

stringrequired

The app slug from List Universal Apps.

The app slug, from List Universal Apps (includeBuiltins=true for If, Loop, Map and the other built-ins).

string

latest, or a version number.

latest (the default) pins the current published version. A version number pins that version.

string

The action id or slug from List Universal Actions.

The action id or slug, from List Universal Actions. Built-ins take none. Left out, the step is added without an action, as in the editor.

string

The step's display name.

The step's display name. Left out, it is named the way the editor names it.

object

Where the step goes: { parentStepId, slot, afterStepId }.

Where the step goes. Left out: last at the top level.

parentStepIdstring
The loop, folder, batch step or If/Else the step goes inside. null or left out: the top level.
slotstring
steps at the top level; body inside a loop, folder or batch step; then or else inside an If/Else. Defaults to steps at the top level.
- stepsThe top level of the workflow.
- bodyInside a loop, a folder, or a step that pages in batches: the steps that run for each item or page.
- thenThe If/Else lane that runs when its conditions are true.
- elseThe If/Else lane that runs otherwise.
afterStepIdstring
The step in that slot to follow. null puts the step first; left out puts it last.

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.