Introduction to working with flows through the APIs
A flow is an automated sequence of marketing-related steps, such as sending a message, updating participant information, or creating an activity. For a conceptual overview, see the Learn - Marketing section. This page details how to create flows using the API.
Creating an EmailFlow
To create a new flow programmatically:
Create a default
EmailFlow
object: Start with the CreateDefaultEmailFlow Agent to initialize a new flow.POST /api/v1/Agents/Workflow/CreateDefaultEmailFlow
Add triggers: Include triggers (in the
EmailFlow
object) to set conditions for when a person is suggested as participant in the flow.POST /api/v1/Agents/Workflow/CreateDefaultWorkflowTrigger
Add steps: Define and incorporate steps (into the
EmailFlow
object) to sequence the flow of actions.POST /api/v1/Agents/Workflow/CreateDefaultWorkflowStepFromType
Save the flow: Use the SaveEmailFlow Agent to finalize and save the configured email flow.
POST /api/v1/Agents/Workflow/SaveEmailFlow
Tip
Explore code examples on GitHub!