Create a campaign
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"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}Campaigns
Create a campaign
Creates a campaign in status draft. Dialer settings (concurrency, retries, calling windows, AMD/voicemail behavior) can be set right away. The plan limit max_campaigns is enforced (archived campaigns do not count). Required scope: campaigns:write (keys without scope restrictions have full access).
POST
/
campaigns
Create a campaign
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"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, 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.
Body
application/json
Assistant that runs the calls. Must belong to your workspace.
Available options:
phone_call, whatsapp_template, whatsapp_call, sms Max parallel campaign calls (1–10). Effective slots also respect plan max_parallel_calls.
Required range:
1 <= x <= 10Required range:
x >= 0Required range:
x >= 1Allowed calling windows per weekday, local to the campaign timezone. Keys: mon–sun; each value is an array of ["HH:MM", "HH:MM"] start/end pairs (24h). An empty array or missing key blocks the whole day.
Show child attributes
Show child attributes
IANA timezone, e.g. Europe/Berlin.
Available options:
hangup, drop_message Required when voicemail_action is drop_message.
Response
The created campaign.
Show child attributes
Show child attributes
⌘I