Update Workflow

Rename a workflow, enable or disable it with isActive, or replace its tags. Send at least one field; only the fields you send change.

PUT

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

Optional headers

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.

Arguments

string

A new name.

boolean

true to enable the workflow, false to disable it.

array of string

The full new set of tag ids from the workflow tag catalog. Replaces the current set.

idstring

Unique id of the workflow.

namestring

The name your team gave the workflow.

typestring

The workflow's type.

isActiveboolean

True while the workflow is enabled and able to run.

isTemplateboolean

True if this is a template rather than a live workflow.

sizestring

The workflow's runner size: xs, sm, md, lg, xl, or xxl. Empty when sized automatically.

tagsarray of string

Ids of the tags on the workflow. The tag catalog is managed in the app.

createdOndate

When the workflow was created.

createdBystring

Who created it.

updatedOndate

When it was last changed.

updatedBystring

Who last changed it.