Skip to main content
POST
Create a workflow

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The name of the workflow.

description
string

The description of the workflow.

mailingListId
string | null

The ID of a mailing list the workflow sends to. After creation, the mailing list can be changed with the POST /v1/workflows/{workflowId}/mailing-list endpoint.

Response

Workflow created.

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