Skip to main content
POST
Add 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_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, 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.

Body

application/json
contact_id
string<uuid>
required

Existing workspace contact/lead ID.

phone
string

Phone number in E.164 format. Separators are stripped.

Example:

"+4930123456"

email
string<email>

Contact email address.

Example:

"contact@example.com"

channel
enum<string>

Channel where the opt-out occurred. When omitted, phone defaults to voice and email defaults to email.

Available options:
voice,
sms,
email,
telegram,
slack,
messenger,
teams,
discord,
gchat,
x,
whatsapp
reason
string

Optional reason (max 500 characters).

Maximum string length: 500
Example:

"Unsubscribe request"

Response

The created entry.

data
object