curl --request PATCH \
--url https://app.famulor.io/api/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"concurrency": 5,
"voicemail_action": "drop_message",
"voicemail_message": "Hi, we tried to reach you — we'll call again later."
}
EOFimport requests
url = "https://app.famulor.io/api/v1/campaigns/{id}"
payload = {
"concurrency": 5,
"voicemail_action": "drop_message",
"voicemail_message": "Hi, we tried to reach you — we'll call again later."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
concurrency: 5,
voicemail_action: 'drop_message',
voicemail_message: 'Hi, we tried to reach you — we\'ll call again later.'
})
};
fetch('https://app.famulor.io/api/v1/campaigns/{id}', 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://app.famulor.io/api/v1/campaigns/{id}",
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([
'concurrency' => 5,
'voicemail_action' => 'drop_message',
'voicemail_message' => 'Hi, we tried to reach you — we\'ll call again later.'
]),
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://app.famulor.io/api/v1/campaigns/{id}"
payload := strings.NewReader("{\n \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\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))
}HttpResponse<String> response = Unirest.patch("https://app.famulor.io/api/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{id}")
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 \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ca1b2c3d-0000-4000-8000-000000000030",
"name": "July outreach",
"status": "draft",
"assistant_id": "a1b2c3d4-0000-4000-8000-000000000001",
"concurrency": 3,
"retry_max": 2,
"retry_delay_minutes": 60,
"calling_windows": {
"mon": [
[
"09:00",
"20:00"
]
],
"tue": [
[
"09:00",
"20:00"
]
]
},
"timezone": "Europe/Berlin",
"amd_enabled": true,
"voicemail_action": "hangup",
"voicemail_message": null,
"started_at": null,
"completed_at": null,
"created_at": "2026-07-01T08:00:00Z",
"updated_at": "2026-07-01T08:00:00Z"
}
}Update a campaign
Updates name, assistant and/or dialer settings. voicemail_action: "drop_message" requires an effective voicemail_message. The sequence can change while the campaign is a draft or paused, also after it was started. Otherwise the call fails with 409: a running campaign says “Pause the campaign to edit the sequence.”, a scheduled one must cancel its schedule first, a completed one must be duplicated. A started campaign keeps its place for every contact that is not finished (pending, queued or calling): the new sequence must still contain each step such a contact sits on, with the same step type (a contact without a step sits on the first step), otherwise the call fails with 409 Step "<name>" still has <n> contacts. Keep the step, or wait until they have moved on. Read sequence_step_contacts of getCampaignStats to see where contacts wait. A step you add to a started campaign needs an id that was never used in it, and so does an outcome you add to a step that has recorded outcomes; a kept step id cannot change its step type once the id has history (409 Give the step a new id. or Give the outcome a new id.). Names, assistants, attempts, messages, waits, outcomes and routes may change; a contact in the middle continues on its step with the new settings (fewer attempts than it already made count as exhausted; a message that went out is not sent again). A wait or delay that is already running keeps its end time; the new value applies from the next send or attempt. The change only applies while the status is still the one that was read: a resume in between fails with 409 The campaign changed while it was saved. Reload it and try again. The mode of the number_pool can no longer change once the campaign has been started (409): duplicate the campaign instead. A changed sequence clears the launch confirmation (launch_attestation), so a paused campaign needs the confirmation again to resume (resumeCampaign or startCampaign with compliance_attestation), and a draft needs to be launched again. The settings only a sequence applies (number_pool, contact_timezone_mode contact, holidays, double_dial) are checked against the campaign as it would be saved (400 without a sequence); removing the sequence resets them to their defaults. Required scope: campaigns:write (keys without scope restrictions have full access).
curl --request PATCH \
--url https://app.famulor.io/api/v1/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"concurrency": 5,
"voicemail_action": "drop_message",
"voicemail_message": "Hi, we tried to reach you — we'll call again later."
}
EOFimport requests
url = "https://app.famulor.io/api/v1/campaigns/{id}"
payload = {
"concurrency": 5,
"voicemail_action": "drop_message",
"voicemail_message": "Hi, we tried to reach you — we'll call again later."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
concurrency: 5,
voicemail_action: 'drop_message',
voicemail_message: 'Hi, we tried to reach you — we\'ll call again later.'
})
};
fetch('https://app.famulor.io/api/v1/campaigns/{id}', 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://app.famulor.io/api/v1/campaigns/{id}",
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([
'concurrency' => 5,
'voicemail_action' => 'drop_message',
'voicemail_message' => 'Hi, we tried to reach you — we\'ll call again later.'
]),
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://app.famulor.io/api/v1/campaigns/{id}"
payload := strings.NewReader("{\n \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\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))
}HttpResponse<String> response = Unirest.patch("https://app.famulor.io/api/v1/campaigns/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{id}")
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 \"concurrency\": 5,\n \"voicemail_action\": \"drop_message\",\n \"voicemail_message\": \"Hi, we tried to reach you — we'll call again later.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ca1b2c3d-0000-4000-8000-000000000030",
"name": "July outreach",
"status": "draft",
"assistant_id": "a1b2c3d4-0000-4000-8000-000000000001",
"concurrency": 3,
"retry_max": 2,
"retry_delay_minutes": 60,
"calling_windows": {
"mon": [
[
"09:00",
"20:00"
]
],
"tue": [
[
"09:00",
"20:00"
]
]
},
"timezone": "Europe/Berlin",
"amd_enabled": true,
"voicemail_action": "hangup",
"voicemail_message": null,
"started_at": null,
"completed_at": null,
"created_at": "2026-07-01T08:00:00Z",
"updated_at": "2026-07-01T08:00:00Z"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Body
Partial update — only the provided fields are changed. At least one valid field is required.
Opt-in external beta audience. Phone calls only with follow-up off. Null selects existing local leads. Current membership, scenario and explicit voice permission are checked before every attempt; no profile mirror. Cannot change after execution starts.
Show child attributes
Show child attributes
Sequence of call and message steps with outcomes and per-step attempts. null keeps the classic retry settings (retry_max, retry_delay_minutes). Campaigns created without it stay classic. Phone call campaigns only; not with an external audience. Draft and paused campaigns can change it, also after they were started (see updateCampaign); a running campaign is paused first, a scheduled one cancels its schedule first, a completed one is duplicated.
Show child attributes
Show child attributes
{
"version": 1,
"start_node_id": "call",
"nodes": [
{
"id": "call",
"name": "Call",
"assistant_id": null,
"attempts": [
{ "delay_minutes": 0 },
{ "delay_minutes": 1440 },
{ "delay_minutes": 1440 }
],
"outcomes": [
{
"id": "not_interested",
"label": "Not interested",
"condition": {
"type": "prompt",
"description": "The contact says they are not interested."
},
"destination": { "type": "end", "successful": false }
}
],
"no_response": {
"destination": { "type": "node", "node_id": "sms_reminder" }
},
"other": { "destination": { "type": "retry" } }
},
{
"id": "sms_reminder",
"name": "SMS reminder",
"channel": "sms",
"assistant_id": null,
"message": {
"config": {
"from_number_id": "6f2c1a52-8d3b-4c47-9a3e-1b7d5e0c9a11",
"message": "Hi {{name}}, we tried to reach you. Reply to this message and we will call you back.",
"variable_mapping": {}
},
"wait_minutes": 1440,
"next": { "type": "end", "successful": false },
"replied": { "type": "end", "successful": true },
"failed": { "type": "end", "successful": false }
}
}
],
"global_outcomes": []
}
Which time zone the calling windows follow. campaign: the campaign's timezone. contact: each contact's own local time, derived from the phone number; needs a sequence (400 without one), because only sequence campaigns apply it.
campaign, contact Redial once immediately when a call ends unanswered or busy. Off by default; true needs a sequence (400 without one), because only sequence campaigns redial; repeated immediate calls can be an unreasonable nuisance under EU law, so check the countries you call before turning it on.