Skip to main content
POST
/
api
/
v1
/
workflow
/
{workflowId}
/
execution
/
bulk
Bulk create workflow executions
curl --request POST \
  --url https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "leads": [
    {
      "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
    }
  ]
}
'
{
  "total": 123,
  "successful": 123,
  "failed": 123,
  "results": [
    {
      "success": true,
      "executionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerLeadId": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Path Parameters

workflowId
string<uuid>
required

Body

application/json
leads
object[]
required

Array of leads to create (max 25)

Required array length: 1 - 25 elements

Response

Bulk workflow execution results

total
integer
required

Total number of leads processed

successful
integer
required

Number of successful leads

failed
integer
required

Number of failed leads

results
object[]
required

Individual results for each lead