Create a campaign
curl --request POST \
--url https://api.folk.app/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"recipients": {
"type": "contacts",
"ids": [
"per_55175e81-9a52-4ac3-930e-82792c23499b"
]
},
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
},
{
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"delayDays": 3,
"sameThread": true
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: 'draft',
groupId: 'grp_bc984b3f-0386-434d-82d7-a91eb6badd71',
recipients: {type: 'contacts', ids: ['per_55175e81-9a52-4ac3-930e-82792c23499b']},
steps: [
{
subject: 'Quick question, {{firstName}}',
body: JSON.stringify('<p>Hi {{firstName}},</p><p>{{signature}}</p>')
},
{
body: JSON.stringify('<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>'),
delayDays: 3,
sameThread: true
}
]
})
};
fetch('https://api.folk.app/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.folk.app/v1/campaigns"
payload = {
"target": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"recipients": {
"type": "contacts",
"ids": ["per_55175e81-9a52-4ac3-930e-82792c23499b"]
},
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
},
{
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"delayDays": 3,
"sameThread": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.folk.app/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 \"target\": \"draft\",\n \"groupId\": \"grp_bc984b3f-0386-434d-82d7-a91eb6badd71\",\n \"recipients\": {\n \"type\": \"contacts\",\n \"ids\": [\n \"per_55175e81-9a52-4ac3-930e-82792c23499b\"\n ]\n },\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n },\n {\n \"body\": \"<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>\",\n \"delayDays\": 3,\n \"sameThread\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.folk.app/v1/campaigns"
payload := strings.NewReader("{\n \"target\": \"draft\",\n \"groupId\": \"grp_bc984b3f-0386-434d-82d7-a91eb6badd71\",\n \"recipients\": {\n \"type\": \"contacts\",\n \"ids\": [\n \"per_55175e81-9a52-4ac3-930e-82792c23499b\"\n ]\n },\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n },\n {\n \"body\": \"<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>\",\n \"delayDays\": 3,\n \"sameThread\": 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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.folk.app/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([
'target' => 'draft',
'groupId' => 'grp_bc984b3f-0386-434d-82d7-a91eb6badd71',
'recipients' => [
'type' => 'contacts',
'ids' => [
'per_55175e81-9a52-4ac3-930e-82792c23499b'
]
],
'steps' => [
[
'subject' => 'Quick question, {{firstName}}',
'body' => '<p>Hi {{firstName}},</p><p>{{signature}}</p>'
],
[
'body' => '<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>',
'delayDays' => 3,
'sameThread' => 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;
}{
"data": {
"id": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b",
"name": "Q3 outreach",
"status": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"entityType": "person",
"steps": [
{
"position": 1,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 0,
"sameThread": false,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
},
{
"position": 2,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "",
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 3,
"sameThread": true,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
}
],
"stopOnReply": true,
"recipientCount": 12,
"createdBy": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
"createdAt": "2025-07-17T09:00:00.000Z",
"updatedAt": "2025-07-17T09:00:00.000Z",
"scheduledAt": null,
"startedAt": null,
"finishedAt": null,
"error": null
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Not enough enrichment credits: 12 needed, 5 left.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#payment-required",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "You have exceeded your rate limit.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#rate-limiting",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z",
"details": {
"policy": "burst",
"limit": 20,
"remaining": 0,
"windowSeconds": 2,
"retryAfter": "2025-10-01T12:00:02.000Z",
"policies": [
{
"policy": "default",
"limit": 600,
"remaining": 412,
"windowSeconds": 60,
"retryAfter": "2025-10-01T12:01:00.000Z"
},
{
"policy": "burst",
"limit": 20,
"remaining": 0,
"windowSeconds": 2,
"retryAfter": "2025-10-01T12:00:02.000Z"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#internal-server-error",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}Campaigns
(Beta) Create a campaign
Create a draft campaign: one or more steps (the first email, then its follow-ups), each a template with {{variables}} sent to every recipient. A draft opens in the app like one created there, to be reviewed and launched, or edited with PATCH /v1/campaigns/:campaignId.
Variables: For people: {{fullName}}, {{firstName}}, {{lastName}}, {{jobTitle}}, {{description}}, {{urls}}, {{companies.name}}, {{companies.urls}}. For companies: {{name}}, {{description}}, {{fundingRaised}}, {{lastFundingDate}}, {{foundationYear}}, {{industry}}, {{employeeRange}}. Array fields use their first value. A text or numeric custom field of the campaign’s group is {{customFieldValues.grp_<uuid>.<field name>}}. A variable without a value for a recipient is removed. Write \{{ for literal braces.
End a body with <p>{{signature}}</p> to sign it with the sender’s signature; a body without it is sent unsigned.
Recipients the request names but that you can’t access, and recipients without an email address, are listed in warnings. Only target: "draft" is supported for now.
This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \
--url https://api.folk.app/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"recipients": {
"type": "contacts",
"ids": [
"per_55175e81-9a52-4ac3-930e-82792c23499b"
]
},
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
},
{
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"delayDays": 3,
"sameThread": true
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: 'draft',
groupId: 'grp_bc984b3f-0386-434d-82d7-a91eb6badd71',
recipients: {type: 'contacts', ids: ['per_55175e81-9a52-4ac3-930e-82792c23499b']},
steps: [
{
subject: 'Quick question, {{firstName}}',
body: JSON.stringify('<p>Hi {{firstName}},</p><p>{{signature}}</p>')
},
{
body: JSON.stringify('<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>'),
delayDays: 3,
sameThread: true
}
]
})
};
fetch('https://api.folk.app/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.folk.app/v1/campaigns"
payload = {
"target": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"recipients": {
"type": "contacts",
"ids": ["per_55175e81-9a52-4ac3-930e-82792c23499b"]
},
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
},
{
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"delayDays": 3,
"sameThread": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.folk.app/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 \"target\": \"draft\",\n \"groupId\": \"grp_bc984b3f-0386-434d-82d7-a91eb6badd71\",\n \"recipients\": {\n \"type\": \"contacts\",\n \"ids\": [\n \"per_55175e81-9a52-4ac3-930e-82792c23499b\"\n ]\n },\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n },\n {\n \"body\": \"<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>\",\n \"delayDays\": 3,\n \"sameThread\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.folk.app/v1/campaigns"
payload := strings.NewReader("{\n \"target\": \"draft\",\n \"groupId\": \"grp_bc984b3f-0386-434d-82d7-a91eb6badd71\",\n \"recipients\": {\n \"type\": \"contacts\",\n \"ids\": [\n \"per_55175e81-9a52-4ac3-930e-82792c23499b\"\n ]\n },\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n },\n {\n \"body\": \"<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>\",\n \"delayDays\": 3,\n \"sameThread\": 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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.folk.app/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([
'target' => 'draft',
'groupId' => 'grp_bc984b3f-0386-434d-82d7-a91eb6badd71',
'recipients' => [
'type' => 'contacts',
'ids' => [
'per_55175e81-9a52-4ac3-930e-82792c23499b'
]
],
'steps' => [
[
'subject' => 'Quick question, {{firstName}}',
'body' => '<p>Hi {{firstName}},</p><p>{{signature}}</p>'
],
[
'body' => '<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>',
'delayDays' => 3,
'sameThread' => 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;
}{
"data": {
"id": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b",
"name": "Q3 outreach",
"status": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"entityType": "person",
"steps": [
{
"position": 1,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 0,
"sameThread": false,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
},
{
"position": 2,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "",
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 3,
"sameThread": true,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
}
],
"stopOnReply": true,
"recipientCount": 12,
"createdBy": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
"createdAt": "2025-07-17T09:00:00.000Z",
"updatedAt": "2025-07-17T09:00:00.000Z",
"scheduledAt": null,
"startedAt": null,
"finishedAt": null,
"error": null
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Not enough enrichment credits: 12 needed, 5 left.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#payment-required",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "You have exceeded your rate limit.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#rate-limiting",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z",
"details": {
"policy": "burst",
"limit": 20,
"remaining": 0,
"windowSeconds": 2,
"retryAfter": "2025-10-01T12:00:02.000Z",
"policies": [
{
"policy": "default",
"limit": 600,
"remaining": 412,
"windowSeconds": 60,
"retryAfter": "2025-10-01T12:01:00.000Z"
},
{
"policy": "burst",
"limit": 20,
"remaining": 0,
"windowSeconds": 2,
"retryAfter": "2025-10-01T12:00:02.000Z"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#internal-server-error",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}Authorizations
API key for authentication
Headers
A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.
Maximum string length:
255Example:
"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
application/json
What to do once the campaign is created. draft stores it, to be finished in the app or edited with PATCH /v1/campaigns/:campaignId. review and launch are not supported yet.
Available options:
draft, review, launch Example:
"draft"
Who receives the campaign: a list of contacts, or the contacts of its group. Between 1 and 5,000 recipients, all people or all companies.
- Option 1
- Option 2
Show child attributes
Show child attributes
The steps of the campaign: the first email, then its follow-ups. More than one step needs sequences on your plan, and a sender that supports them (not Gmail).
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
The group to create the campaign in. Its text and numeric custom fields can be used as variables. Leave it out to send to a list of contacts.
Required string length:
40Example:
"grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
The sender of every step. Set either a root sender for every step, or a sender on every step, not both. Without any, every step is sent from the sender you last used.
- Option 1
- Option 2
Show child attributes
Show child attributes
Example:
{ "email": "john.doe@example.com" }
Whether the remaining steps stop for a recipient who replied. Defaults to true.
Example:
true
When to send, with launch. Not supported yet.
Maximum string length:
64Personalized messages, with review and launch. Not supported yet.
Maximum array length:
10000Show child attributes
Show child attributes
Response
The campaign created, with its steps.
A campaign: one or more emails, each a step, sent to a list of people or companies.
Show child attributes
Show child attributes
Example:
{
"id": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b",
"name": "Q3 outreach",
"status": "draft",
"groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
"entityType": "person",
"steps": [
{
"position": 1,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 0,
"sameThread": false,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
},
{
"position": 2,
"sender": {
"id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
"email": "john.doe@example.com",
"displayName": "John Doe"
},
"subject": "",
"body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
"cc": [],
"bcc": [],
"delayDays": 3,
"sameThread": true,
"status": "draft",
"messageCount": 0,
"sentCount": 0,
"notSentCount": 0
}
],
"stopOnReply": true,
"recipientCount": 12,
"createdBy": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
"createdAt": "2025-07-17T09:00:00.000Z",
"updatedAt": "2025-07-17T09:00:00.000Z",
"scheduledAt": null,
"startedAt": null,
"finishedAt": null,
"error": null
}
Example:
["This field is deprecated"]