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
    }
  ]
}
'
import requests

url = "https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk"

payload = { "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
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
]
})
};

fetch('https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk"

payload := strings.NewReader("{\n \"leads\": [\n {\n \"customerLeadId\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"state\": \"<string>\",\n \"forwardingPhoneNumber\": \"<string>\",\n \"variables\": {},\n \"metadata\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"priorityDate\": \"2025-01-15T00:00:00Z\",\n \"startAt\": \"2025-01-15T15:30:00Z\",\n \"attempt\": 0\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"leads\": [\n {\n \"customerLeadId\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"state\": \"<string>\",\n \"forwardingPhoneNumber\": \"<string>\",\n \"variables\": {},\n \"metadata\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"priorityDate\": \"2025-01-15T00:00:00Z\",\n \"startAt\": \"2025-01-15T15:30:00Z\",\n \"attempt\": 0\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://prod.featherhq.com/api/v1/workflow/{workflowId}/execution/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"leads\": [\n {\n \"customerLeadId\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"state\": \"<string>\",\n \"forwardingPhoneNumber\": \"<string>\",\n \"variables\": {},\n \"metadata\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"priorityDate\": \"2025-01-15T00:00:00Z\",\n \"startAt\": \"2025-01-15T15:30:00Z\",\n \"attempt\": 0\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "total": 123,
  "successful": 123,
  "failed": 123,
  "results": [
    {
      "success": true,
      "executionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerLeadId": "<string>",
      "error": "<string>"
    }
  ]
}
{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}
{
"status": 402,
"message": "Insufficient credits",
"code": "PAYMENT_REQUIRED",
"success": false
}
{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}

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