curl --request POST \
--url https://app.famulor.io/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "July outreach",
"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"
]
],
"wed": [
[
"09:00",
"20:00"
]
],
"thu": [
[
"09:00",
"20:00"
]
],
"fri": [
[
"09:00",
"18:00"
]
]
},
"timezone": "Europe/Berlin",
"amd_enabled": true,
"voicemail_action": "hangup"
}
'import requests
url = "https://app.famulor.io/api/v1/campaigns"
payload = {
"name": "July outreach",
"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"]],
"wed": [["09:00", "20:00"]],
"thu": [["09:00", "20:00"]],
"fri": [["09:00", "18:00"]]
},
"timezone": "Europe/Berlin",
"amd_enabled": True,
"voicemail_action": "hangup"
}
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: 'July outreach',
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']],
wed: [['09:00', '20:00']],
thu: [['09:00', '20:00']],
fri: [['09:00', '18:00']]
},
timezone: 'Europe/Berlin',
amd_enabled: true,
voicemail_action: 'hangup'
})
};
fetch('https://app.famulor.io/api/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://app.famulor.io/api/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' => 'July outreach',
'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'
]
],
'wed' => [
[
'09:00',
'20:00'
]
],
'thu' => [
[
'09:00',
'20:00'
]
],
'fri' => [
[
'09:00',
'18:00'
]
]
],
'timezone' => 'Europe/Berlin',
'amd_enabled' => true,
'voicemail_action' => 'hangup'
]),
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"
payload := strings.NewReader("{\n \"name\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\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://app.famulor.io/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/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\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\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"
}
}Create a campaign
Creates a campaign in status draft. Dialer settings (concurrency, retries, calling windows, AMD/voicemail behavior) can be set right away. Phone call campaigns can also set a sequence of call and message steps; only a campaign with a sequence can set a number_pool, holidays, double_dial or the contact_timezone_mode contact (400 otherwise), because the classic dialer does not apply them. Without sequence the campaign keeps the classic retry settings. The plan’s campaign limit is enforced (archived campaigns do not count). Sequences and number pools need a plan that includes Campaign sequences (403, reason campaign_sequences_unavailable); a sequence that starts with a message step also needs multi-channel campaigns (403). Every message step is checked like a message campaign of that channel: SMS sender, approved WhatsApp template, verified assistant email address (the error names the step). Required scope: campaigns:write (keys without scope restrictions have full access).
curl --request POST \
--url https://app.famulor.io/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "July outreach",
"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"
]
],
"wed": [
[
"09:00",
"20:00"
]
],
"thu": [
[
"09:00",
"20:00"
]
],
"fri": [
[
"09:00",
"18:00"
]
]
},
"timezone": "Europe/Berlin",
"amd_enabled": true,
"voicemail_action": "hangup"
}
'import requests
url = "https://app.famulor.io/api/v1/campaigns"
payload = {
"name": "July outreach",
"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"]],
"wed": [["09:00", "20:00"]],
"thu": [["09:00", "20:00"]],
"fri": [["09:00", "18:00"]]
},
"timezone": "Europe/Berlin",
"amd_enabled": True,
"voicemail_action": "hangup"
}
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: 'July outreach',
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']],
wed: [['09:00', '20:00']],
thu: [['09:00', '20:00']],
fri: [['09:00', '18:00']]
},
timezone: 'Europe/Berlin',
amd_enabled: true,
voicemail_action: 'hangup'
})
};
fetch('https://app.famulor.io/api/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://app.famulor.io/api/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' => 'July outreach',
'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'
]
],
'wed' => [
[
'09:00',
'20:00'
]
],
'thu' => [
[
'09:00',
'20:00'
]
],
'fri' => [
[
'09:00',
'18:00'
]
]
],
'timezone' => 'Europe/Berlin',
'amd_enabled' => true,
'voicemail_action' => 'hangup'
]),
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"
payload := strings.NewReader("{\n \"name\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\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://app.famulor.io/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/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\": \"July outreach\",\n \"assistant_id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"concurrency\": 3,\n \"retry_max\": 2,\n \"retry_delay_minutes\": 60,\n \"calling_windows\": {\n \"mon\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"tue\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"wed\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"thu\": [\n [\n \"09:00\",\n \"20:00\"\n ]\n ],\n \"fri\": [\n [\n \"09:00\",\n \"18:00\"\n ]\n ]\n },\n \"timezone\": \"Europe/Berlin\",\n \"amd_enabled\": true,\n \"voicemail_action\": \"hangup\"\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
Optional voice follow-up after retries are exhausted. channel is off | whatsapp_template | sms | email. An sms follow-up names its sender with exactly one of from_number_id (a workspace number) or rcs_sender_id (a company name, RCS). Email is follow-up only and uses subject, message, and variable_mapping; it sends from the campaign assistant address. A campaign with a sequence takes no follow-up: any channel other than off is rejected with 400 (use message steps in the sequence instead), also when the request adds a sequence to a campaign whose stored follow-up is on and does not turn it off.
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.