Build workflows with the API
Create and update workflow graphs, change mailing lists, and add, branch, edit, or delete nodes from code. Send events to start published workflows.
Workflows
Available
Lifecycle emails your agent can build and edit
Manage your entire user lifecycle with your agent. Create workflows, add and branch nodes, edit individual steps, and trigger published workflows with events.
Workflows
Create, list, read, and update workflows. You can also change the mailing list attached to a workflow.
GET /v1/workflows
List workflows
POST /v1/workflows
Create a workflow
GET /v1/workflows/{workflowId}
Get a workflow
POST /v1/workflows/{workflowId}
Update a workflow
POST /v1/workflows/{workflowId}/mailing-list
Change the workflow’s mailing list
Workflow nodes
Create and inspect nodes, update their configuration, add branches, or delete one node and its downstream path.
POST /v1/workflows/{workflowId}/nodes
Create a workflow node
GET /v1/workflows/{workflowId}/nodes/{nodeId}
Get workflow node details
POST /v1/workflows/{workflowId}/nodes/{nodeId}
Update a workflow node
POST /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch
Add a branch below a node
DELETE /v1/workflows/{workflowId}/nodes/{nodeId}
Delete one workflow node
DELETE /v1/workflows/{workflowId}/nodes/{nodeId}/recursive
Delete a node and all downstream nodes
Trigger workflows with events
Use the Events API to send the event that starts a published workflow for a contact.