curl --request POST \
--url https://app.famulor.io/api/v1/suppression-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"reason": "Unsubscribe request",
"direction": "outbound"
}
'import requests
url = "https://app.famulor.io/api/v1/suppression-list"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"reason": "Unsubscribe request",
"direction": "outbound"
}
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({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phone: '+4930123456',
email: 'contact@example.com',
reason: 'Unsubscribe request',
direction: 'outbound'
})
};
fetch('https://app.famulor.io/api/v1/suppression-list', 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/suppression-list",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phone' => '+4930123456',
'email' => 'contact@example.com',
'reason' => 'Unsubscribe request',
'direction' => 'outbound'
]),
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/suppression-list"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\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/suppression-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list")
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 \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"identity_type": "phone",
"identity": "<string>",
"scope": "all",
"origin_channel": "voice",
"purpose": "marketing",
"reason": "Unsubscribe request",
"source": "<string>",
"mode_at_opt_out": "universal",
"direction": "outbound",
"created_at": "2023-11-07T05:31:56Z"
}
}Add a suppression entry
Adds a contact identified by contact ID, phone, or email to the suppression list. With the default direction: outbound this records a marketing opt-out: the contact is never called, texted, or emailed. With direction: inbound, incoming calls from the phone number are hung up immediately, and SMS, WhatsApp, other messengers, and email from that phone or email get no AI reply and no reply charge; the messages stay visible in History, and incoming SMS and RCS on purchased numbers still cost the normal receive fee. both combines the two. inbound and both need a phone or email. If the contact already has an active entry with the other direction, that entry is upgraded to both and returned. The current workspace consent mode determines whether outbound blocking is universal or limited to the originating channel; inbound blocking always applies to every channel of that phone number or email address. Required scope: suppression:write.
curl --request POST \
--url https://app.famulor.io/api/v1/suppression-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"reason": "Unsubscribe request",
"direction": "outbound"
}
'import requests
url = "https://app.famulor.io/api/v1/suppression-list"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"reason": "Unsubscribe request",
"direction": "outbound"
}
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({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phone: '+4930123456',
email: 'contact@example.com',
reason: 'Unsubscribe request',
direction: 'outbound'
})
};
fetch('https://app.famulor.io/api/v1/suppression-list', 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/suppression-list",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phone' => '+4930123456',
'email' => 'contact@example.com',
'reason' => 'Unsubscribe request',
'direction' => 'outbound'
]),
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/suppression-list"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\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/suppression-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list")
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 \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phone\": \"+4930123456\",\n \"email\": \"contact@example.com\",\n \"reason\": \"Unsubscribe request\",\n \"direction\": \"outbound\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"identity_type": "phone",
"identity": "<string>",
"scope": "all",
"origin_channel": "voice",
"purpose": "marketing",
"reason": "Unsubscribe request",
"source": "<string>",
"mode_at_opt_out": "universal",
"direction": "outbound",
"created_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
- Option 1
- Option 2
- Option 3
Channel where the opt-out occurred. When omitted, phone defaults to voice and email defaults to email.
voice, sms, email, telegram, slack, messenger, teams, discord, gchat, x, whatsapp, linear, notion, twitch, mattermost, webex, lark, line, sendblue, linq, zernio, freshdesk, gmail, outlook, zendesk, servicenow, intercom, zoho_mail, agent_mail, instagram, zulip Which contacts to block. outbound (default): never contact this person. inbound: do not answer their incoming calls and messages. both: both. inbound and both need a phone or email; with only contact_id the request is rejected with 422. When the contact already has an active entry with the other direction, that entry is upgraded to both.
outbound, inbound, both