curl --request PATCH \
--url https://app.famulor.io/api/v1/settings/dnc-registry \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"org_id": "12345678-12345",
"san": "12345678-123456-78"
}
'import requests
url = "https://app.famulor.io/api/v1/settings/dnc-registry"
payload = {
"enabled": True,
"org_id": "12345678-12345",
"san": "12345678-123456-78"
}
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({enabled: true, org_id: '12345678-12345', san: '12345678-123456-78'})
};
fetch('https://app.famulor.io/api/v1/settings/dnc-registry', 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/settings/dnc-registry",
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([
'enabled' => true,
'org_id' => '12345678-12345',
'san' => '12345678-123456-78'
]),
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/settings/dnc-registry"
payload := strings.NewReader("{\n \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\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/settings/dnc-registry")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/settings/dnc-registry")
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 \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"org_id": "<string>",
"san": "<string>",
"status": "off",
"updated_at": "2023-11-07T05:31:56Z"
}
}Update federal and state DNC checks
Turns Federal and State DNC Checks on or off and stores the FTC Org ID and SAN. Turning the checks on requires both identifiers; turning them off keeps them. Send only the fields you change. While the checks are on and unverified, proactive calls to US numbers wait instead of being dialed. Required scope: settings:write.
curl --request PATCH \
--url https://app.famulor.io/api/v1/settings/dnc-registry \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"org_id": "12345678-12345",
"san": "12345678-123456-78"
}
'import requests
url = "https://app.famulor.io/api/v1/settings/dnc-registry"
payload = {
"enabled": True,
"org_id": "12345678-12345",
"san": "12345678-123456-78"
}
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({enabled: true, org_id: '12345678-12345', san: '12345678-123456-78'})
};
fetch('https://app.famulor.io/api/v1/settings/dnc-registry', 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/settings/dnc-registry",
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([
'enabled' => true,
'org_id' => '12345678-12345',
'san' => '12345678-123456-78'
]),
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/settings/dnc-registry"
payload := strings.NewReader("{\n \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\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/settings/dnc-registry")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/settings/dnc-registry")
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 \"enabled\": true,\n \"org_id\": \"12345678-12345\",\n \"san\": \"12345678-123456-78\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"org_id": "<string>",
"san": "<string>",
"status": "off",
"updated_at": "2023-11-07T05:31:56Z"
}
}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
Turn federal and state DNC checks on or off. Turning them on needs an Org ID and SAN, sent now or saved before.
FTC National Do Not Call Registry Org ID: 3 to 40 letters, digits or hyphens. Spaces are removed and letters upper-cased. null or an empty string clears it while the checks are off.
"12345678-12345"
FTC Subscription Account Number (SAN): 3 to 40 letters, digits or hyphens. Spaces are removed and letters upper-cased. null or an empty string clears it while the checks are off.
"12345678-123456-78"
Response
The updated federal and state DNC check settings.
Show child attributes
Show child attributes