• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

Introduction to working with flows through the APIs

Audience:
api
•
Version: 10.3.5
Some tooltip text!
• 1 minute to read
 • 1 minute to read

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:

  1. Create a default EmailFlow object: Start with the CreateDefaultEmailFlow Agent to initialize a new flow.

    POST /api/v1/Agents/Workflow/CreateDefaultEmailFlow
    
  2. 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
    
  3. Add steps: Define and incorporate steps (into the EmailFlow object) to sequence the flow of actions.

    POST /api/v1/Agents/Workflow/CreateDefaultWorkflowStepFromType
    
  4. 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!

In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top