curl --request PATCH \
--url https://app.famulor.io/api/v1/suppression-list/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"direction": "both",
"reason": "Daily spam calls"
}
'import requests
url = "https://app.famulor.io/api/v1/suppression-list/{id}"
payload = {
"direction": "both",
"reason": "Daily spam calls"
}
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({direction: 'both', reason: 'Daily spam calls'})
};
fetch('https://app.famulor.io/api/v1/suppression-list/{id}', 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/{id}",
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([
'direction' => 'both',
'reason' => 'Daily spam calls'
]),
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/{id}"
payload := strings.NewReader("{\n \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\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/suppression-list/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list/{id}")
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 \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\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"
}
}Change a suppression entry
Changes the direction and/or the reason of one active suppression entry. The entry keeps its contact identity, scope and source. Changing the direction is recorded in the consent history: lifting the outbound block appends an opt-in event, adding a direction an opt-out event. inbound and both need an entry with a phone number or email address. Send at least one of direction or reason; reason: null or an empty string clears it. Required scope: suppression:write.
curl --request PATCH \
--url https://app.famulor.io/api/v1/suppression-list/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"direction": "both",
"reason": "Daily spam calls"
}
'import requests
url = "https://app.famulor.io/api/v1/suppression-list/{id}"
payload = {
"direction": "both",
"reason": "Daily spam calls"
}
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({direction: 'both', reason: 'Daily spam calls'})
};
fetch('https://app.famulor.io/api/v1/suppression-list/{id}', 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/{id}",
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([
'direction' => 'both',
'reason' => 'Daily spam calls'
]),
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/{id}"
payload := strings.NewReader("{\n \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\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/suppression-list/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list/{id}")
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 \"direction\": \"both\",\n \"reason\": \"Daily spam calls\"\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
outbound: the contact is never called, texted, or emailed (scope applies). inbound: incoming calls from the phone number are hung up immediately and incoming SMS, WhatsApp, other messenger, and email messages from that phone or email get no AI reply and no reply charge; they stay visible in History (incoming SMS and RCS on purchased numbers still cost the normal receive fee). Inbound blocking covers every channel of the identity regardless of scope. both: both. Automatic opt-outs (STOP replies, verbal do-not-call requests, email unsubscribes, imports) are always outbound. Opt-in (for example an SMS START reply) only lifts the outbound part.
outbound, inbound, both "outbound"