Skip to main content
POST
Create workflow execution

Authorizations

X-API-Key
string
header
required

Path Parameters

workflowId
string<uuid>
required

Body

application/json
customerLeadId
string
required

Customer lead identifier

primaryPhone
string
required
Pattern: ^\+1(\d{10}|\d{3}-\d{3}-\d{4})|^\+[1-9]\d{1,14}$
zipcode
string | null
Pattern: ^\d{5}(-?\d{4})?$
state
string | null
forwardingPhoneNumber
string
Pattern: ^\+1(\d{10}|\d{3}-\d{3}-\d{4})|^\+[1-9]\d{1,14}$
variables
object

Variables for the execution

metadata
object

Additional metadata for the execution

priorityDate
string<date-time>

Lead priority date (ISO 8601). Later/newer dates = higher priority. Defaults to creation time.

Example:

"2025-01-15T00:00:00Z"

startAt
string<date-time>

Deferred execution start time (ISO 8601 with timezone). The first workflow step delay is applied after this time.

Example:

"2025-01-15T15:30:00Z"

attempt
integer
default:0

Starting step index for the execution (0-indexed). Must be less than the total number of steps in the workflow.

Required range: x >= 0
Example:

0

Response

Agent workflow execution created successfully

id
string<uuid>
required

Execution ID

workflowId
string<uuid>
required

Workflow ID

status
enum<string>
required

Execution status

Available options:
CREATED,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
PAUSED
startedAt
string
required

Execution start timestamp

completedAt
string | null
required

Execution completion timestamp

customerLeadId
string | null
required

Customer lead identifier

primaryPhone
string | null
required

Primary phone number

metadata
required

Execution metadata

disposition
enum<string> | null
required

Final execution disposition

Available options:
COULD_NOT_CONNECT,
NO_ANSWER,
LEFT_VOICEMAIL,
VOICEMAIL_DETECTED,
SILENCE_TIMEOUT,
BAD_NUMBER,
NOT_INTERESTED,
WARM_TRANSFER,
WARM_TRANSFER_FAILED,
CALENDLY,
DNC,
ENDED,
FRAUD,
LINE_BUSY,
TEXT_CONSENT,
CALL_AGAIN
definition
object
required

Workflow definition snapshot

stepExecutions
object[]
required

Step executions

createdAt
string
required

Creation timestamp

variables
object

Variables for the execution

stepIndex
number

Current step index being processed

nextRunAt
string | null

Next scheduled run timestamp

priorityDate
string | null

Lead priority date