curl --request POST \
--url https://app.famulor.io/api/v1/campaigns/{id}/launch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compliance_attestation": true,
"start_at": null
}
'import requests
url = "https://app.famulor.io/api/v1/campaigns/{id}/launch"
payload = {
"compliance_attestation": True,
"start_at": None
}
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({compliance_attestation: true, start_at: null})
};
fetch('https://app.famulor.io/api/v1/campaigns/{id}/launch', 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}/launch",
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([
'compliance_attestation' => true,
'start_at' => null
]),
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}/launch"
payload := strings.NewReader("{\n \"compliance_attestation\": true,\n \"start_at\": null\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/{id}/launch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compliance_attestation\": true,\n \"start_at\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{id}/launch")
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 \"compliance_attestation\": true,\n \"start_at\": null\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "ca1b2c3d-0000-4000-8000-000000000030",
"status": "running",
"scheduled_start_at": null,
"tick": {
"dialed": 3,
"skipped": 0
}
}
}Launch a campaign
Starts a draft or scheduled campaign now, or schedules it, after you confirm that it complies with all laws and consent requirements that apply to the contacts being called (compliance_attestation: true). The same checks apply either way: assistant, sequence, number pool, plan limit and contacts. The confirmation is stored with the campaign: who, when, from which surface and which wording version. A sequence campaign cannot be started on any surface without it. Send the sequence_hash from getCampaign, unchanged, to make sure the sequence has not changed since you reviewed it (409, reason sequence_changed). Without compliance_attestation the call fails with 400 and reason attestation_required. Required scope: campaigns:write (keys without scope restrictions have full access).
curl --request POST \
--url https://app.famulor.io/api/v1/campaigns/{id}/launch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compliance_attestation": true,
"start_at": null
}
'import requests
url = "https://app.famulor.io/api/v1/campaigns/{id}/launch"
payload = {
"compliance_attestation": True,
"start_at": None
}
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({compliance_attestation: true, start_at: null})
};
fetch('https://app.famulor.io/api/v1/campaigns/{id}/launch', 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}/launch",
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([
'compliance_attestation' => true,
'start_at' => null
]),
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}/launch"
payload := strings.NewReader("{\n \"compliance_attestation\": true,\n \"start_at\": null\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/{id}/launch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compliance_attestation\": true,\n \"start_at\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{id}/launch")
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 \"compliance_attestation\": true,\n \"start_at\": null\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "ca1b2c3d-0000-4000-8000-000000000030",
"status": "running",
"scheduled_start_at": null,
"tick": {
"dialed": 3,
"skipped": 0
}
}
}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.