Update a campaign
curl --request PATCH \
--url https://api.folk.app/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
subject: 'Quick question, {{firstName}}',
body: JSON.stringify('<p>Hi {{firstName}},</p><p>{{signature}}</p>')
}
]
})
};
fetch('https://api.folk.app/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.folk.app/v1/campaigns/{campaignId}"
payload = { "steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.folk.app/v1/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\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/{campaignId}"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'steps' => [
[
'subject' => 'Quick question, {{firstName}}',
'body' => '<p>Hi {{firstName}},</p><p>{{signature}}</p>'
]
]
]),
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) Update a campaign
Edit a draft campaign: its sender, its steps or whether it stops on reply. steps replaces every step, so send them all, as read from GET /v1/campaigns/:campaignId. Recipients and whether they are people or companies can’t change.
This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.
PATCH
/
v1
/
campaigns
/
{campaignId}
Update a campaign
curl --request PATCH \
--url https://api.folk.app/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
}
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
subject: 'Quick question, {{firstName}}',
body: JSON.stringify('<p>Hi {{firstName}},</p><p>{{signature}}</p>')
}
]
})
};
fetch('https://api.folk.app/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.folk.app/v1/campaigns/{campaignId}"
payload = { "steps": [
{
"subject": "Quick question, {{firstName}}",
"body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.folk.app/v1/campaigns/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\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/{campaignId}"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"subject\": \"Quick question, {{firstName}}\",\n \"body\": \"<p>Hi {{firstName}},</p><p>{{signature}}</p>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'steps' => [
[
'subject' => 'Quick question, {{firstName}}',
'body' => '<p>Hi {{firstName}},</p><p>{{signature}}</p>'
]
]
]),
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"
Path Parameters
The ID of the campaign.
Required string length:
40Body
application/json
The sender of every step. Set either a root sender for every step, or a sender on every step, not both. A step whose sender changes gets the new sender's signature, or none when they have none.
- Option 1
- Option 2
Show child attributes
Show child attributes
Example:
{ "email": "john.doe@example.com" }
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). They replace the current steps: steps match by position, extra steps are added and missing ones removed. A body ending with {{signature}} keeps the step's signature as stored, edited or not.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Whether the remaining steps stop for a recipient who replied.
Example:
true
Response
The campaign, 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"]