Skip to main content
POST
/
api
/
v1
/
workflow
/
{workflowId}
/
execution
Create workflow execution
curl --request POST \
  --url https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerLeadId": "<string>",
  "primaryPhone": "<string>",
  "zipcode": "<string>",
  "state": "<string>",
  "forwardingPhoneNumber": "<string>",
  "variables": {},
  "metadata": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "priorityDate": "2025-01-15T00:00:00Z",
  "startAt": "2025-01-15T15:30:00Z",
  "attempt": 0
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CREATED",
  "startedAt": "<string>",
  "completedAt": "<string>",
  "customerLeadId": "<string>",
  "primaryPhone": "<string>",
  "metadata": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "disposition": "COULD_NOT_CONNECT",
  "definition": {
    "steps": [
      {
        "type": "CALL",
        "order": 2,
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delayInSecs": 0,
        "finishOn": [],
        "leaveVoicemail": false,
        "initialMessage": "<string>",
        "count": 1
      }
    ],
    "isInfinite": false
  },
  "stepExecutions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflowExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "PENDING",
      "type": "CALL",
      "order": 123,
      "delayInSecs": 123,
      "finishOn": [
        "COULD_NOT_CONNECT"
      ],
      "startedAt": "<string>",
      "completedAt": "<string>",
      "leaveVoicemail": true,
      "disposition": "COULD_NOT_CONNECT",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentCall": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "callStartedAt": "<string>",
        "callEndedAt": "<string>",
        "callDuration": 123,
        "callEndedReason": "COULD_NOT_CONNECT",
        "recordingUrl": "<string>",
        "summary": "<string>"
      }
    }
  ],
  "createdAt": "<string>",
  "variables": {},
  "stepIndex": 123,
  "nextRunAt": "<string>",
  "priorityDate": "<string>"
}

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,
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