Add a suppression entry
Records a marketing opt-out for a contact identified by contact ID, phone, or email. The current workspace consent mode determines whether the resulting scope is universal or limited to the originating channel. Required scope: suppression:write.
Authorizations
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
- Option 1
- Option 2
- Option 3
Existing workspace contact/lead ID.
Phone number in E.164 format. Separators are stripped.
"+4930123456"
Contact email address.
"contact@example.com"
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 Optional reason (max 500 characters).
500"Unsubscribe request"
Response
The created entry.