Skip to main content
POST
Update a workflow
To change a workflow’s mailing list, use the Change workflow mailing list endpoint instead. This is because changing mailing lists may remove queued contacts from the workflow.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowId
string
required

The ID of the workflow.

Body

application/json

At least one property must be provided.

expectedRevisionId
string | null
required

The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass null back as expectedRevisionId in that case. If the token is stale, the API returns a 409 Conflict error.

name
string
required

The updated workflow name.

description
string

The updated workflow description.

Response

Workflow properties updated.

id
string
required

The ID of the workflow.

workflowRevisionId
string | null
required

The current workflow revision token. Pass the latest value as expectedRevisionId on the next workflow mutation. Will be null for workflows without a revision token yet.

status
enum<string>
required
Available options:
Draft,
Sending,
Paused,
PausedAndQueueing
mailingListId
string | null
required

The ID of the mailing list the workflow sends to.

rootNodeId
string
required

The ID of the root node in the workflow graph.

nodes
object
required

A map of node IDs to simplified node objects. Each node includes typeName and nextNodeIds, plus type-specific fields when present. To get the full node object, use the GET /v1/workflows/{workflowId}/nodes/{nodeId} endpoint.

Example:
name
string

The name of the workflow.

description
string

The description of the workflow.

Last modified on July 22, 2026