Skip to main content
PATCH
Change a suppression entry

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
string<uuid>
required

Suppression entry ID (from GET /suppression-list).

Body

application/json
direction
enum<string>

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.

Available options:
outbound,
inbound,
both
Example:

"outbound"

reason
string | null

New reason. null or an empty string clears it.

Maximum string length: 500

Response

The updated entry.

data
object