Skip to main content
PATCH
Updates a workflow automation. Only draft and paused workflows can be edited — active workflows must be paused first. Pass active: true to re-activate as part of the update.
When steps is provided, the supplied array fully replaces the existing step list. Steps not included will be removed and any in-flight executions on those steps will exit.

Authorizations

string | header
required
Project API key header of the form Bearer AS_<key>.

Path Parameters

string
required
Workflow automation ID.

Body

All fields are optional. See Create Automation for the full shape of each field.
string
New workflow name. Maximum length 255.
string
Maximum length 1000.
object
Replacement entry criteria.
object
Replacement exit criteria.
object[]
Replacement step list. Fully replaces the existing steps. Every email step must be preceded by a wait step (use a delay of 0 to send immediately), including email steps inside a branch.
string[]
Replacement tag list.
string
Suppression group applied to all email steps.
boolean
boolean
boolean
When true, the workflow is validated and activated after the update. When false, the workflow is left in (or moved to) draft state.

Response

Workflow automation updated successfully
boolean
Example: true
object
The updated workflow automation.

Error Responses

object
Returned when the workflow is active or archived — pause it first.
object