Create automation
curl --request POST \
--url https://api.stardex.ai/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"trigger": {
"type": "schedule",
"rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"dtstart": "<string>",
"timezone": "<string>",
"next_run_at": "<string>"
},
"actions": [
{
"action_type": "send_email",
"payload": {
"subject": "<string>",
"body": "<string>",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"email_addresses": [
"jsmith@example.com"
],
"include_signature": true
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 2,
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"is_enabled": true,
"runs_on_api_changes": false
}
'import requests
url = "https://api.stardex.ai/v1/automations"
payload = {
"name": "<string>",
"trigger": {
"type": "schedule",
"rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"dtstart": "<string>",
"timezone": "<string>",
"next_run_at": "<string>"
},
"actions": [
{
"action_type": "send_email",
"payload": {
"subject": "<string>",
"body": "<string>",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"email_addresses": ["jsmith@example.com"],
"include_signature": True
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 2,
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"is_enabled": True,
"runs_on_api_changes": False
}
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: '<string>',
trigger: {
type: 'schedule',
rrule: 'FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0',
dtstart: '<string>',
timezone: '<string>',
next_run_at: '<string>'
},
actions: [
{
action_type: 'send_email',
payload: {
subject: '<string>',
body: JSON.stringify('<string>'),
sender: {kind: 'mailbox', nylas_grant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
email_addresses: ['jsmith@example.com'],
include_signature: true
},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position: 2,
team_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
is_enabled: true,
runs_on_api_changes: false
})
};
fetch('https://api.stardex.ai/v1/automations', 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/automations",
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' => '<string>',
'trigger' => [
'type' => 'schedule',
'rrule' => 'FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0',
'dtstart' => '<string>',
'timezone' => '<string>',
'next_run_at' => '<string>'
],
'actions' => [
[
'action_type' => 'send_email',
'payload' => [
'subject' => '<string>',
'body' => '<string>',
'sender' => [
'kind' => 'mailbox',
'nylas_grant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'email_addresses' => [
'jsmith@example.com'
],
'include_signature' => true
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position' => 2,
'team_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'is_enabled' => true,
'runs_on_api_changes' => false
]),
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/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\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/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/automations")
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\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2222",
"name": "Email owner when a candidate is rejected",
"is_enabled": true,
"is_archived": false,
"runs_on_api_changes": false,
"created_by": "567e8901-e23c-45d6-e789-012345678901",
"trigger": {
"type": "candidate_status_changed",
"pipeline_stage_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"match_rejection_stages": true
},
"actions": [
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2223",
"position": 1,
"action_type": "send_email",
"recipient_type": "candidate",
"team_member_id": null,
"payload": {
"subject": "Your application for {{job_name}}",
"body": "Hi {{candidate_first_name}},\n\nThank you for your time on the {{job_name}} search.\n\nBest,\n{{search_owner}}",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "8b3f4e5d-6c7a-4182-9c9d-0e1f2a3b4c5d"
},
"include_signature": true
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2228",
"position": 2,
"action_type": "send_email",
"recipient_type": "team_members",
"team_member_id": null,
"payload": {
"subject": "{{candidate_name}} was rejected on {{job_name}}",
"body": "{{candidate_name}} moved to {{stage_name}} on {{job_name}}.",
"team_member_ids": [
"567e8901-e23c-45d6-e789-012345678901"
],
"email_addresses": [
"finance@yourfirm.com"
]
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2226",
"position": 3,
"action_type": "delay",
"payload": {
"amount": 2,
"unit": "days"
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2224",
"position": 4,
"action_type": "add_note",
"team_member_id": "567e8901-e23c-45d6-e789-012345678901",
"payload": {
"content": "Rejected by automation — review before closing the loop."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2225",
"position": 5,
"action_type": "agent_instructions",
"payload": {
"instructions": "Summarize why this candidate was rejected."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2227",
"position": 6,
"action_type": "create_task",
"assignee_type": "job_owner",
"team_member_id": null,
"payload": {
"content": "Call {{candidate_name}} with feedback on {{job_name}}",
"task_type": "call",
"due_in_days": 1
}
}
],
"created_at": "2026-08-21T10:00:00Z",
"updated_at": "2026-08-21T10:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Automations
Create automation
Create an automation with exactly one trigger and one or more actions.
add_note and send_email to a candidate are only valid when trigger.type is candidate_status_changed. Schedule next_run_at is computed from rrule, dtstart, and timezone. Only organization admins (or an API key) can create, change, turn off or archive automations during the Beta.
POST
/
v1
/
automations
Create automation
curl --request POST \
--url https://api.stardex.ai/v1/automations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"trigger": {
"type": "schedule",
"rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"dtstart": "<string>",
"timezone": "<string>",
"next_run_at": "<string>"
},
"actions": [
{
"action_type": "send_email",
"payload": {
"subject": "<string>",
"body": "<string>",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"email_addresses": [
"jsmith@example.com"
],
"include_signature": true
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 2,
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"is_enabled": true,
"runs_on_api_changes": false
}
'import requests
url = "https://api.stardex.ai/v1/automations"
payload = {
"name": "<string>",
"trigger": {
"type": "schedule",
"rrule": "FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
"dtstart": "<string>",
"timezone": "<string>",
"next_run_at": "<string>"
},
"actions": [
{
"action_type": "send_email",
"payload": {
"subject": "<string>",
"body": "<string>",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"email_addresses": ["jsmith@example.com"],
"include_signature": True
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 2,
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"is_enabled": True,
"runs_on_api_changes": False
}
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: '<string>',
trigger: {
type: 'schedule',
rrule: 'FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0',
dtstart: '<string>',
timezone: '<string>',
next_run_at: '<string>'
},
actions: [
{
action_type: 'send_email',
payload: {
subject: '<string>',
body: JSON.stringify('<string>'),
sender: {kind: 'mailbox', nylas_grant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
email_addresses: ['jsmith@example.com'],
include_signature: true
},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position: 2,
team_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
is_enabled: true,
runs_on_api_changes: false
})
};
fetch('https://api.stardex.ai/v1/automations', 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/automations",
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' => '<string>',
'trigger' => [
'type' => 'schedule',
'rrule' => 'FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0',
'dtstart' => '<string>',
'timezone' => '<string>',
'next_run_at' => '<string>'
],
'actions' => [
[
'action_type' => 'send_email',
'payload' => [
'subject' => '<string>',
'body' => '<string>',
'sender' => [
'kind' => 'mailbox',
'nylas_grant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'email_addresses' => [
'jsmith@example.com'
],
'include_signature' => true
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position' => 2,
'team_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'is_enabled' => true,
'runs_on_api_changes' => false
]),
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/automations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\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/automations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/automations")
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\": \"<string>\",\n \"trigger\": {\n \"type\": \"schedule\",\n \"rrule\": \"FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0\",\n \"dtstart\": \"<string>\",\n \"timezone\": \"<string>\",\n \"next_run_at\": \"<string>\"\n },\n \"actions\": [\n {\n \"action_type\": \"send_email\",\n \"payload\": {\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"sender\": {\n \"kind\": \"mailbox\",\n \"nylas_grant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"email_addresses\": [\n \"jsmith@example.com\"\n ],\n \"include_signature\": true\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 2,\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"is_enabled\": true,\n \"runs_on_api_changes\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2222",
"name": "Email owner when a candidate is rejected",
"is_enabled": true,
"is_archived": false,
"runs_on_api_changes": false,
"created_by": "567e8901-e23c-45d6-e789-012345678901",
"trigger": {
"type": "candidate_status_changed",
"pipeline_stage_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"match_rejection_stages": true
},
"actions": [
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2223",
"position": 1,
"action_type": "send_email",
"recipient_type": "candidate",
"team_member_id": null,
"payload": {
"subject": "Your application for {{job_name}}",
"body": "Hi {{candidate_first_name}},\n\nThank you for your time on the {{job_name}} search.\n\nBest,\n{{search_owner}}",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "8b3f4e5d-6c7a-4182-9c9d-0e1f2a3b4c5d"
},
"include_signature": true
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2228",
"position": 2,
"action_type": "send_email",
"recipient_type": "team_members",
"team_member_id": null,
"payload": {
"subject": "{{candidate_name}} was rejected on {{job_name}}",
"body": "{{candidate_name}} moved to {{stage_name}} on {{job_name}}.",
"team_member_ids": [
"567e8901-e23c-45d6-e789-012345678901"
],
"email_addresses": [
"finance@yourfirm.com"
]
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2226",
"position": 3,
"action_type": "delay",
"payload": {
"amount": 2,
"unit": "days"
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2224",
"position": 4,
"action_type": "add_note",
"team_member_id": "567e8901-e23c-45d6-e789-012345678901",
"payload": {
"content": "Rejected by automation — review before closing the loop."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2225",
"position": 5,
"action_type": "agent_instructions",
"payload": {
"instructions": "Summarize why this candidate was rejected."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2227",
"position": 6,
"action_type": "create_task",
"assignee_type": "job_owner",
"team_member_id": null,
"payload": {
"content": "Call {{candidate_name}} with feedback on {{job_name}}",
"task_type": "call",
"due_in_days": 1
}
}
],
"created_at": "2026-08-21T10:00:00Z",
"updated_at": "2026-08-21T10:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Body
application/json
Display name (required).
Minimum string length:
1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Ordered actions. At least one is required.
Minimum array length:
1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Whether the automation is enabled. Defaults to true.
When true, changes made through the API or MCP (including Zapier) also start this automation. Off by default, because one API call can change hundreds of records and each change starts a run. Defaults to false.
Was this page helpful?