Prepare an enrollment

curl --request POST \
  --url https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
  "from_email": "riya@acmetalent.com",
  "job_id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
  "job_pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
  "start_mode": "scheduled",
  "start_at": "2026-10-19T09:00:00",
  "start_timezone": "Europe/London",
  "variable_values": {
    "custom": "We placed 3 engineers at Monzo last year."
  },
  "recipients": [
    {
      "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
      "variable_values": {
        "personalization_line": "Loved your PyCon talk on async Python."
      },
      "blank_variables": [
        "custom"
      ]
    },
    {
      "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73"
    },
    {
      "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24"
    },
    {
      "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
      "variable_values": {
        "personalization_line": "Your QCon London talk was great."
      }
    }
  ]
}
'

import requests

url = "https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches"

payload = {
    "sender_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
    "from_email": "riya@acmetalent.com",
    "job_id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
    "job_pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
    "start_mode": "scheduled",
    "start_at": "2026-10-19T09:00:00",
    "start_timezone": "Europe/London",
    "variable_values": { "custom": "We placed 3 engineers at Monzo last year." },
    "recipients": [
        {
            "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
            "variable_values": { "personalization_line": "Loved your PyCon talk on async Python." },
            "blank_variables": ["custom"]
        },
        { "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73" },
        { "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24" },
        {
            "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
            "variable_values": { "personalization_line": "Your QCon London talk was great." }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sender_team_member_id: '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
    from_email: 'riya@acmetalent.com',
    job_id: 'b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13',
    job_pipeline_stage_id: 'e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88',
    start_mode: 'scheduled',
    start_at: '2026-10-19T09:00:00',
    start_timezone: 'Europe/London',
    variable_values: {custom: 'We placed 3 engineers at Monzo last year.'},
    recipients: [
      {
        person_id: '2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40',
        variable_values: {personalization_line: 'Loved your PyCon talk on async Python.'},
        blank_variables: ['custom']
      },
      {person_id: '6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73'},
      {person_id: '9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24'},
      {
        person_id: '4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95',
        variable_values: {personalization_line: 'Your QCon London talk was great.'}
      }
    ]
  })
};

fetch('https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches', 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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches",
  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([
    'sender_team_member_id' => '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
    'from_email' => 'riya@acmetalent.com',
    'job_id' => 'b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13',
    'job_pipeline_stage_id' => 'e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88',
    'start_mode' => 'scheduled',
    'start_at' => '2026-10-19T09:00:00',
    'start_timezone' => 'Europe/London',
    'variable_values' => [
        'custom' => 'We placed 3 engineers at Monzo last year.'
    ],
    'recipients' => [
        [
                'person_id' => '2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40',
                'variable_values' => [
                                'personalization_line' => 'Loved your PyCon talk on async Python.'
                ],
                'blank_variables' => [
                                'custom'
                ]
        ],
        [
                'person_id' => '6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73'
        ],
        [
                'person_id' => '9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24'
        ],
        [
                'person_id' => '4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95',
                'variable_values' => [
                                'personalization_line' => 'Your QCon London talk was great.'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches"

	payload := strings.NewReader("{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "batch_id": "eb8d2f41-3c7a-4e19-b5d2-7f0a1c9e6b34",
    "status": "preparing",
    "version": 1,
    "source": "api",
    "campaign": {
      "id": "3f9a1c27-8e4b-4d2a-b6f0-7c1e5a9d2b84",
      "name": "Senior Backend Engineer, Monzo"
    },
    "sender": {
      "team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
      "name": "Riya Kapoor",
      "from_email": "riya@acmetalent.com"
    },
    "job": {
      "id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
      "title": "Senior Backend Engineer",
      "pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
      "pipeline_stage": "Contacted"
    },
    "start": {
      "mode": "scheduled",
      "at": "2026-10-19T08:00:00.000Z",
      "timezone": "Europe/London"
    },
    "created_by": {
      "type": "api_key",
      "id": "0d4b8f2e-6a1c-4e9b-b3d7-5f2a8c1e4b96",
      "name": "Greenhouse sync"
    },
    "created_at": "2026-10-13T11:20:00.000Z",
    "expires_at": "2026-10-14T11:20:00.000Z",
    "started_at": null,
    "progress": {
      "done": 1,
      "total": 4
    },
    "summary": {
      "total": 4,
      "preparing": 3,
      "ready": 0,
      "needs_input": 0,
      "blocked": 1,
      "excluded": 0,
      "enrolled": 0,
      "rejected_at_start": 0
    },
    "warnings": [],
    "recipients": [
      {
        "recipient_id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5b7a9c21",
        "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
        "name": "Sam Patel",
        "email": "sam@gmail.com",
        "status": "preparing",
        "issues": [
          {
            "code": "enrolled_in_other_campaign",
            "message": "Also in 'Q4 platform engineers' (running).",
            "details": {
              "campaigns": [
                "Q4 platform engineers"
              ]
            }
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "b2d4f6a8-3c5e-4a7b-9d1f-2e4a6c8b0d32",
        "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73",
        "name": "Tom Reed",
        "email": "tom@reed.dev",
        "status": "preparing",
        "issues": [],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "c3e5a7b9-4d6f-4b8c-ae2a-3f5b7d9c1e43",
        "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24",
        "name": "Priya Shah",
        "email": "priya@shah.io",
        "status": "blocked",
        "issues": [
          {
            "code": "unsubscribed",
            "message": "Unsubscribed from your emails on 2 Sep 2026."
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "d4f6b8ca-5e7a-4c9d-bf3b-4a6c8e0d2f54",
        "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
        "name": "Mark Chen",
        "email": "mark.chen@gmail.com",
        "status": "preparing",
        "issues": [
          {
            "code": "company_do_not_contact",
            "message": "Works at Globex, which is marked do not contact. Override with a reason to include them.",
            "details": {
              "companies": [
                "Globex"
              ]
            }
          },
          {
            "code": "likely_bounce",
            "message": "This email looks risky and may bounce."
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      }
    ],
    "sample": null
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Campaigns

Prepare an enrollment

Creates a draft enrollment batch: checks every person, fills their variables and writes each person’s final emails. Nothing is enrolled or sent until you call start. Each person comes back ready, needs_input or blocked with the reasons in issues; fix people with PATCH .../recipients/{recipient_id}. When the campaign uses AI variables the batch is preparing while they are written; read it again until it is ready. A draft expires 24 hours after its last change. With API keys, MCP and Ask Dex together, a workspace can enroll up to 500 people in 24 hours by default (429 DAILY_ENROLLMENT_LIMIT_REACHED). Needs campaigns:enroll.

Signed-in users need access to campaigns in their role. API keys need the campaigns permission named on each endpoint.

POST

campaigns

{id}

enrollment-batches

Prepare an enrollment

curl --request POST \
  --url https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
  "from_email": "riya@acmetalent.com",
  "job_id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
  "job_pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
  "start_mode": "scheduled",
  "start_at": "2026-10-19T09:00:00",
  "start_timezone": "Europe/London",
  "variable_values": {
    "custom": "We placed 3 engineers at Monzo last year."
  },
  "recipients": [
    {
      "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
      "variable_values": {
        "personalization_line": "Loved your PyCon talk on async Python."
      },
      "blank_variables": [
        "custom"
      ]
    },
    {
      "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73"
    },
    {
      "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24"
    },
    {
      "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
      "variable_values": {
        "personalization_line": "Your QCon London talk was great."
      }
    }
  ]
}
'

import requests

url = "https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches"

payload = {
    "sender_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
    "from_email": "riya@acmetalent.com",
    "job_id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
    "job_pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
    "start_mode": "scheduled",
    "start_at": "2026-10-19T09:00:00",
    "start_timezone": "Europe/London",
    "variable_values": { "custom": "We placed 3 engineers at Monzo last year." },
    "recipients": [
        {
            "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
            "variable_values": { "personalization_line": "Loved your PyCon talk on async Python." },
            "blank_variables": ["custom"]
        },
        { "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73" },
        { "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24" },
        {
            "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
            "variable_values": { "personalization_line": "Your QCon London talk was great." }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sender_team_member_id: '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
    from_email: 'riya@acmetalent.com',
    job_id: 'b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13',
    job_pipeline_stage_id: 'e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88',
    start_mode: 'scheduled',
    start_at: '2026-10-19T09:00:00',
    start_timezone: 'Europe/London',
    variable_values: {custom: 'We placed 3 engineers at Monzo last year.'},
    recipients: [
      {
        person_id: '2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40',
        variable_values: {personalization_line: 'Loved your PyCon talk on async Python.'},
        blank_variables: ['custom']
      },
      {person_id: '6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73'},
      {person_id: '9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24'},
      {
        person_id: '4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95',
        variable_values: {personalization_line: 'Your QCon London talk was great.'}
      }
    ]
  })
};

fetch('https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches', 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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches",
  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([
    'sender_team_member_id' => '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
    'from_email' => 'riya@acmetalent.com',
    'job_id' => 'b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13',
    'job_pipeline_stage_id' => 'e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88',
    'start_mode' => 'scheduled',
    'start_at' => '2026-10-19T09:00:00',
    'start_timezone' => 'Europe/London',
    'variable_values' => [
        'custom' => 'We placed 3 engineers at Monzo last year.'
    ],
    'recipients' => [
        [
                'person_id' => '2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40',
                'variable_values' => [
                                'personalization_line' => 'Loved your PyCon talk on async Python.'
                ],
                'blank_variables' => [
                                'custom'
                ]
        ],
        [
                'person_id' => '6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73'
        ],
        [
                'person_id' => '9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24'
        ],
        [
                'person_id' => '4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95',
                'variable_values' => [
                                'personalization_line' => 'Your QCon London talk was great.'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches"

	payload := strings.NewReader("{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.stardex.ai/v1/campaigns/{id}/enrollment-batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stardex.ai/v1/campaigns/{id}/enrollment-batches")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sender_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n  \"from_email\": \"riya@acmetalent.com\",\n  \"job_id\": \"b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13\",\n  \"job_pipeline_stage_id\": \"e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88\",\n  \"start_mode\": \"scheduled\",\n  \"start_at\": \"2026-10-19T09:00:00\",\n  \"start_timezone\": \"Europe/London\",\n  \"variable_values\": {\n    \"custom\": \"We placed 3 engineers at Monzo last year.\"\n  },\n  \"recipients\": [\n    {\n      \"person_id\": \"2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40\",\n      \"variable_values\": {\n        \"personalization_line\": \"Loved your PyCon talk on async Python.\"\n      },\n      \"blank_variables\": [\n        \"custom\"\n      ]\n    },\n    {\n      \"person_id\": \"6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73\"\n    },\n    {\n      \"person_id\": \"9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24\"\n    },\n    {\n      \"person_id\": \"4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95\",\n      \"variable_values\": {\n        \"personalization_line\": \"Your QCon London talk was great.\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "batch_id": "eb8d2f41-3c7a-4e19-b5d2-7f0a1c9e6b34",
    "status": "preparing",
    "version": 1,
    "source": "api",
    "campaign": {
      "id": "3f9a1c27-8e4b-4d2a-b6f0-7c1e5a9d2b84",
      "name": "Senior Backend Engineer, Monzo"
    },
    "sender": {
      "team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
      "name": "Riya Kapoor",
      "from_email": "riya@acmetalent.com"
    },
    "job": {
      "id": "b21d7e4a-5c9f-4e3b-a1d6-8f2c4e7b9a13",
      "title": "Senior Backend Engineer",
      "pipeline_stage_id": "e4a0c3b7-1f5d-4a8e-9b2c-6d3f7a1e5c88",
      "pipeline_stage": "Contacted"
    },
    "start": {
      "mode": "scheduled",
      "at": "2026-10-19T08:00:00.000Z",
      "timezone": "Europe/London"
    },
    "created_by": {
      "type": "api_key",
      "id": "0d4b8f2e-6a1c-4e9b-b3d7-5f2a8c1e4b96",
      "name": "Greenhouse sync"
    },
    "created_at": "2026-10-13T11:20:00.000Z",
    "expires_at": "2026-10-14T11:20:00.000Z",
    "started_at": null,
    "progress": {
      "done": 1,
      "total": 4
    },
    "summary": {
      "total": 4,
      "preparing": 3,
      "ready": 0,
      "needs_input": 0,
      "blocked": 1,
      "excluded": 0,
      "enrolled": 0,
      "rejected_at_start": 0
    },
    "warnings": [],
    "recipients": [
      {
        "recipient_id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5b7a9c21",
        "person_id": "2f6b9d1e-4a8c-4e3f-b7d2-1c5a9e3b7f40",
        "name": "Sam Patel",
        "email": "sam@gmail.com",
        "status": "preparing",
        "issues": [
          {
            "code": "enrolled_in_other_campaign",
            "message": "Also in 'Q4 platform engineers' (running).",
            "details": {
              "campaigns": [
                "Q4 platform engineers"
              ]
            }
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "b2d4f6a8-3c5e-4a7b-9d1f-2e4a6c8b0d32",
        "person_id": "6a3e8c2f-9b1d-4f7a-a5c3-8e2b6d4f1a73",
        "name": "Tom Reed",
        "email": "tom@reed.dev",
        "status": "preparing",
        "issues": [],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "c3e5a7b9-4d6f-4b8c-ae2a-3f5b7d9c1e43",
        "person_id": "9c4f1a7e-2d8b-4e6c-b3a9-5f1d7c3e8b24",
        "name": "Priya Shah",
        "email": "priya@shah.io",
        "status": "blocked",
        "issues": [
          {
            "code": "unsubscribed",
            "message": "Unsubscribed from your emails on 2 Sep 2026."
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      },
      {
        "recipient_id": "d4f6b8ca-5e7a-4c9d-bf3b-4a6c8e0d2f54",
        "person_id": "4e8b2d6f-1a3c-4e9b-8f5d-7c2a6e1b3d95",
        "name": "Mark Chen",
        "email": "mark.chen@gmail.com",
        "status": "preparing",
        "issues": [
          {
            "code": "company_do_not_contact",
            "message": "Works at Globex, which is marked do not contact. Override with a reason to include them.",
            "details": {
              "companies": [
                "Globex"
              ]
            }
          },
          {
            "code": "likely_bounce",
            "message": "This email looks risky and may bounce."
          }
        ],
        "overrides": [],
        "override_reason": null,
        "enrollment_id": null,
        "first_email_estimated_at": null
      }
    ],
    "sample": null
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

string<uuid>

required

Campaign ID.

Body

application/json

from_email

string<email>

required

Mailbox to send from: the sender's own or one shared with them. See GET /v1/campaigns/mailboxes.

recipients

object[]

required

People to enroll, each person once. A batch holds up to your workspace's recipient limit (50 by default), and never more than 1,000.

Required array length: 1 - 1000 elements

Show child attributes

sender_team_member_id

string<uuid>

Team member the emails are sent as. Required with an API key; signed-in users always send as themselves.

job_id

string<uuid> | null

Job to add everyone to, which also fills {{search_name}}, {{search_client}} and {{application_link}}.

job_pipeline_stage_id

string<uuid> | null

Pipeline stage of job_id to put everyone in. Left out, people already on the job keep their stage and new ones start in the job's first stage.

start_mode

enum<string>

default:next_window

next_window (default): the first step's wait counts from now, then the email goes out in its next sending window, skipping weekends and holidays the campaign doesn't send on. now: the first email goes out right away, even outside sending hours, on a weekend or holiday, or when the first step has a wait. scheduled: the first email goes out at start_at in start_timezone, even outside sending hours or on a weekend or holiday; if the first step has a wait, it counts from start_at and the email then goes out in the next sending window. The outside_sending_window warning tells you when the first email goes out off schedule or has to wait.

Available options:

next_window,

now,

scheduled

start_at

string | null

When to start, only with start_mode scheduled: a local date and time such as 2026-10-19T09:00:00, read in start_timezone, 5 minutes to 90 days ahead. A batch's timing can't be changed after it is prepared; to move it, discard the batch and prepare a new one.

start_timezone

string | null

IANA timezone for start_at, for example Europe/London. Required with start_mode scheduled.

email_preference

enum<string>

default:auto

Which email to pick for people without one given. auto: work emails for business development and client nurture campaigns, personal emails otherwise. The person's preferred email always wins.

Available options:

auto,

work,

personal

variable_values

object

Values used for everyone in the batch. A person's own variable_values win.

Show child attributes

blank_variables

string[]

Variables to leave out for everyone in the batch.

Maximum array length: 100

Required string length: 1 - 100

override_reason

string | null

Reason used for every person with overrides and no own reason.

Required string length: 1 - 1000

Response

Batch prepared

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

API Documentation

Activity Reports

Automations

Calendar Meetings

Campaigns

Candidates

Client Contacts

Companies

Company Activities

Company Insights

Custom Fields

Deal Activities

Deals

Job Activities

Job Offers

Jobs

Lists

Meeting Recordings

Person Activities

Persons

Scorecards

Tasks

Team Capacity

Team Members

Webhooks

Prepare an enrollment

Authorizations

Path Parameters

Body

Response