Create campaign
curl --request POST \
--url https://api.stardex.ai/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"owner_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"enable_sequence_automation": true,
"stop_on_response": true,
"link_tracking": true,
"open_tracking": false,
"steps": [
{
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
]
},
{
"type": "email",
"send_after_days": 3,
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true
},
{
"type": "manual",
"send_after_days": 2,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"block_until_task_complete": true
}
]
}
EOFimport requests
url = "https://api.stardex.ai/v1/campaigns"
payload = {
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"owner_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"enable_sequence_automation": True,
"stop_on_response": True,
"link_tracking": True,
"open_tracking": False,
"steps": [
{
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": True,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
]
},
{
"type": "email",
"send_after_days": 3,
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": True
},
{
"type": "manual",
"send_after_days": 2,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"block_until_task_complete": True
}
]
}
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({
name: 'Senior Backend Engineer, Monzo',
sequence_type: 'candidate',
owner_team_member_id: '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
enable_sequence_automation: true,
stop_on_response: true,
link_tracking: true,
open_tracking: false,
steps: [
{
type: 'email',
send_after_days: 0,
subject: '{{search_name}} role at {{search_client}}',
body_html: '<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I\'m hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target="_blank" rel="noopener noreferrer nofollow" href="{{application_link}}">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>',
timezone: 'Europe/London',
time_window_start: '09:00',
time_window_end: '17:00',
include_signature: true,
ai_variables: [
{
name: 'opening_line',
description: 'One sentence on the most relevant thing they have built or led recently.'
}
]
},
{
type: 'email',
send_after_days: 3,
body_html: '<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>',
timezone: 'Europe/London',
time_window_start: '09:00',
time_window_end: '17:00',
include_signature: true
},
{
type: 'manual',
send_after_days: 2,
body_html: '<div>Call {{first_name}} if they opened but did not reply.</div>',
block_until_task_complete: true
}
]
})
};
fetch('https://api.stardex.ai/v1/campaigns', 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",
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([
'name' => 'Senior Backend Engineer, Monzo',
'sequence_type' => 'candidate',
'owner_team_member_id' => '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
'enable_sequence_automation' => true,
'stop_on_response' => true,
'link_tracking' => true,
'open_tracking' => false,
'steps' => [
[
'type' => 'email',
'send_after_days' => 0,
'subject' => '{{search_name}} role at {{search_client}}',
'body_html' => '<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I\'m hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target="_blank" rel="noopener noreferrer nofollow" href="{{application_link}}">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>',
'timezone' => 'Europe/London',
'time_window_start' => '09:00',
'time_window_end' => '17:00',
'include_signature' => true,
'ai_variables' => [
[
'name' => 'opening_line',
'description' => 'One sentence on the most relevant thing they have built or led recently.'
]
]
],
[
'type' => 'email',
'send_after_days' => 3,
'body_html' => '<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>',
'timezone' => 'Europe/London',
'time_window_start' => '09:00',
'time_window_end' => '17:00',
'include_signature' => true
],
[
'type' => 'manual',
'send_after_days' => 2,
'body_html' => '<div>Call {{first_name}} if they opened but did not reply.</div>',
'block_until_task_complete' => true
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/campaigns")
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 \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3f9a1c27-8e4b-4d2a-b6f0-7c1e5a9d2b84",
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"is_archived": false,
"created_by": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"step_count": 3,
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z",
"enable_sequence_automation": true,
"stop_on_response": true,
"send_on_weekends": false,
"send_on_holidays": false,
"link_tracking": true,
"open_tracking": false,
"include_unsubscribe_link": false,
"steps": [
{
"id": "5b0f3c8e-2a71-4d0e-9a51-6f0c2d7e1a43",
"order": 1,
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"block_until_task_complete": false,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z"
},
{
"id": "9d2e7a14-61c3-4b8f-8f0e-3a5c9b2d4e17",
"order": 2,
"type": "email",
"send_after_days": 3,
"subject": "Re: {{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"block_until_task_complete": false,
"ai_variables": [],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z"
},
{
"id": "c4a8e2f1-7b3d-4e6a-9c1f-2d8b5a7e3f90",
"order": 3,
"type": "manual",
"send_after_days": 2,
"subject": null,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"timezone": "Europe/London",
"time_window_start": null,
"time_window_end": null,
"include_signature": false,
"block_until_task_complete": true,
"ai_variables": [],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": null
}
],
"manual_variables": [
"personalization_line",
"custom"
],
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently.",
"step_ids": [
"5b0f3c8e-2a71-4d0e-9a51-6f0c2d7e1a43"
]
}
],
"enrollment_counts": {
"total": 0,
"running": 0,
"awaiting_task": 0,
"replied": 0,
"meeting_booked": 0,
"bounced": 0,
"completed": 0,
"stopped": 0
},
"engagement": {
"responded": 0,
"interested": 0,
"neutral": 0,
"not_interested": 0,
"opened": 0,
"clicked": 0,
"reply_rate": null,
"open_rate": null,
"click_rate": 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": {}
}
}Campaigns
Create campaign
Create a campaign and its steps in one request. Creating a campaign sends nothing.
Subjects: only the first email step needs a subject. Later email steps reply in the same thread, so their subject is set to Re: <first subject>.
Variables: use names from GET /v1/campaigns/variables, your own manual names, or {{ai:name}} with a description in the step ai_variables.
Nurture campaigns (candidate_nurture, client_nurture) keep going after a reply and never move people through a pipeline, so stop_on_response and enable_sequence_automation are always false for them.
Owner: signed-in users own what they create. API keys can set owner_team_member_id; otherwise the admin who created the key owns it. Needs campaigns:write.
POST
/
v1
/
campaigns
Create campaign
curl --request POST \
--url https://api.stardex.ai/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"owner_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"enable_sequence_automation": true,
"stop_on_response": true,
"link_tracking": true,
"open_tracking": false,
"steps": [
{
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
]
},
{
"type": "email",
"send_after_days": 3,
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true
},
{
"type": "manual",
"send_after_days": 2,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"block_until_task_complete": true
}
]
}
EOFimport requests
url = "https://api.stardex.ai/v1/campaigns"
payload = {
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"owner_team_member_id": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"enable_sequence_automation": True,
"stop_on_response": True,
"link_tracking": True,
"open_tracking": False,
"steps": [
{
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": True,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
]
},
{
"type": "email",
"send_after_days": 3,
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": True
},
{
"type": "manual",
"send_after_days": 2,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"block_until_task_complete": True
}
]
}
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({
name: 'Senior Backend Engineer, Monzo',
sequence_type: 'candidate',
owner_team_member_id: '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
enable_sequence_automation: true,
stop_on_response: true,
link_tracking: true,
open_tracking: false,
steps: [
{
type: 'email',
send_after_days: 0,
subject: '{{search_name}} role at {{search_client}}',
body_html: '<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I\'m hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target="_blank" rel="noopener noreferrer nofollow" href="{{application_link}}">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>',
timezone: 'Europe/London',
time_window_start: '09:00',
time_window_end: '17:00',
include_signature: true,
ai_variables: [
{
name: 'opening_line',
description: 'One sentence on the most relevant thing they have built or led recently.'
}
]
},
{
type: 'email',
send_after_days: 3,
body_html: '<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>',
timezone: 'Europe/London',
time_window_start: '09:00',
time_window_end: '17:00',
include_signature: true
},
{
type: 'manual',
send_after_days: 2,
body_html: '<div>Call {{first_name}} if they opened but did not reply.</div>',
block_until_task_complete: true
}
]
})
};
fetch('https://api.stardex.ai/v1/campaigns', 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",
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([
'name' => 'Senior Backend Engineer, Monzo',
'sequence_type' => 'candidate',
'owner_team_member_id' => '7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20',
'enable_sequence_automation' => true,
'stop_on_response' => true,
'link_tracking' => true,
'open_tracking' => false,
'steps' => [
[
'type' => 'email',
'send_after_days' => 0,
'subject' => '{{search_name}} role at {{search_client}}',
'body_html' => '<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I\'m hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target="_blank" rel="noopener noreferrer nofollow" href="{{application_link}}">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>',
'timezone' => 'Europe/London',
'time_window_start' => '09:00',
'time_window_end' => '17:00',
'include_signature' => true,
'ai_variables' => [
[
'name' => 'opening_line',
'description' => 'One sentence on the most relevant thing they have built or led recently.'
]
]
],
[
'type' => 'email',
'send_after_days' => 3,
'body_html' => '<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>',
'timezone' => 'Europe/London',
'time_window_start' => '09:00',
'time_window_end' => '17:00',
'include_signature' => true
],
[
'type' => 'manual',
'send_after_days' => 2,
'body_html' => '<div>Call {{first_name}} if they opened but did not reply.</div>',
'block_until_task_complete' => true
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/campaigns")
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 \"name\": \"Senior Backend Engineer, Monzo\",\n \"sequence_type\": \"candidate\",\n \"owner_team_member_id\": \"7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20\",\n \"enable_sequence_automation\": true,\n \"stop_on_response\": true,\n \"link_tracking\": true,\n \"open_tracking\": false,\n \"steps\": [\n {\n \"type\": \"email\",\n \"send_after_days\": 0,\n \"subject\": \"{{search_name}} role at {{search_client}}\",\n \"body_html\": \"<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\\\"_blank\\\" rel=\\\"noopener noreferrer nofollow\\\" href=\\\"{{application_link}}\\\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true,\n \"ai_variables\": [\n {\n \"name\": \"opening_line\",\n \"description\": \"One sentence on the most relevant thing they have built or led recently.\"\n }\n ]\n },\n {\n \"type\": \"email\",\n \"send_after_days\": 3,\n \"body_html\": \"<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>\",\n \"timezone\": \"Europe/London\",\n \"time_window_start\": \"09:00\",\n \"time_window_end\": \"17:00\",\n \"include_signature\": true\n },\n {\n \"type\": \"manual\",\n \"send_after_days\": 2,\n \"body_html\": \"<div>Call {{first_name}} if they opened but did not reply.</div>\",\n \"block_until_task_complete\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3f9a1c27-8e4b-4d2a-b6f0-7c1e5a9d2b84",
"name": "Senior Backend Engineer, Monzo",
"sequence_type": "candidate",
"is_archived": false,
"created_by": "7c1e4a9b-3d6f-4b2e-8a5c-9f1d3b7e5a20",
"step_count": 3,
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z",
"enable_sequence_automation": true,
"stop_on_response": true,
"send_on_weekends": false,
"send_on_holidays": false,
"link_tracking": true,
"open_tracking": false,
"include_unsubscribe_link": false,
"steps": [
{
"id": "5b0f3c8e-2a71-4d0e-9a51-6f0c2d7e1a43",
"order": 1,
"type": "email",
"send_after_days": 0,
"subject": "{{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}},</div><div><br></div><div>{{ai:opening_line}} I'm hiring a <strong>{{search_name}}</strong> at {{search_client}}. {{personalization_line}}</div><div><br></div><div>You can see the role <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"{{application_link}}\">here</a>. Open to a chat?</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"block_until_task_complete": false,
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently."
}
],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z"
},
{
"id": "9d2e7a14-61c3-4b8f-8f0e-3a5c9b2d4e17",
"order": 2,
"type": "email",
"send_after_days": 3,
"subject": "Re: {{search_name}} role at {{search_client}}",
"body_html": "<div>Hi {{first_name}}, following up on my note. {{custom}}</div><div><br></div><div>{{sender_first_name}}</div>",
"timezone": "Europe/London",
"time_window_start": "09:00",
"time_window_end": "17:00",
"include_signature": true,
"block_until_task_complete": false,
"ai_variables": [],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": "2026-10-13T10:15:00.000Z"
},
{
"id": "c4a8e2f1-7b3d-4e6a-9c1f-2d8b5a7e3f90",
"order": 3,
"type": "manual",
"send_after_days": 2,
"subject": null,
"body_html": "<div>Call {{first_name}} if they opened but did not reply.</div>",
"timezone": "Europe/London",
"time_window_start": null,
"time_window_end": null,
"include_signature": false,
"block_until_task_complete": true,
"ai_variables": [],
"attachments": [],
"created_at": "2026-10-13T10:15:00.000Z",
"updated_at": null
}
],
"manual_variables": [
"personalization_line",
"custom"
],
"ai_variables": [
{
"name": "opening_line",
"description": "One sentence on the most relevant thing they have built or led recently.",
"step_ids": [
"5b0f3c8e-2a71-4d0e-9a51-6f0c2d7e1a43"
]
}
],
"enrollment_counts": {
"total": 0,
"running": 0,
"awaiting_task": 0,
"replied": 0,
"meeting_booked": 0,
"bounced": 0,
"completed": 0,
"stopped": 0
},
"engagement": {
"responded": 0,
"interested": 0,
"neutral": 0,
"not_interested": 0,
"opened": 0,
"clicked": 0,
"reply_rate": null,
"open_rate": null,
"click_rate": 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": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Body
application/json
Campaign name.
Required string length:
1 - 200Steps in the order they run, up to 20.
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Who the campaign is for. See GET /v1/campaigns/types. Defaults to candidate.
Available options:
candidate, business_development, candidate_nurture, client_nurture Move people through the linked job pipeline as they reply. Always off for nurture campaigns.
Stop emailing a person once they reply. Always off for nurture campaigns.
Allow emails to go out on Saturdays and Sundays.
Allow emails to go out on public holidays. When off, the campaign skips the holidays in your workspace's holiday calendar.
Track link clicks.
Track email opens.
Add an unsubscribe link to every email.
API keys only: the team member who owns the campaign. Defaults to the admin who created the key. Signed-in users always own the campaigns they create.
Was this page helpful?