Skip to main content
POST
Create a new workflow
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.
A workflow is a sequence of steps (nodes) connected by transitions (edges) that a lead moves through over time. Each node can be a voice call, a time delay, a conditional branch, or an application action. The outcome of each step determines which path the lead takes next.

When to use workflows

Workflows are ideal for:
  • Lead nurture sequences: Call a lead, wait 2 days, call again if no answer, then mark them as unresponsive after 3 attempts.
  • Re-engagement drips: Try a prospect twice, then route them to a different agent script if there is still no answer.
  • Conditional follow-ups: After a first call, if the lead said “interested”, route them to a booking agent; if they said “not interested”, mark them as closed.

Workflow vs. campaign

Getting started

  1. Create the workflow with this endpoint.
  2. Add nodes via Create Node, with one node per step.
  3. Connect nodes via Create Edge to define transitions.
  4. Enrol leads via Upload Workflow Leads.
  5. Activate the workflow via Activate.

Authorizations

Authorization
string
header
required

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

Headers

x-organization-id
string
required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Body

application/json
title
string
required

Title of the workflow (max 100 characters)

Maximum string length: 100
Example:

"Customer Onboarding Workflow"

description
string

Description of the workflow

Example:

"Automated workflow for customer onboarding process"

status
enum<string>

Status of the workflow

Available options:
draft,
active,
paused,
completed,
cancelled
Example:

"draft"

Response

Workflow created successfully