Add a suppression entry
Adds one email address, domain or phone number to the team’s do-not-contact list.
- Matching. An
emailentry matches that address in any letter case. Adomainentry matches every address at the domain and its subdomains. Aphoneentry matches the number however it is formatted, and a North American number with or without its leading1. - Effect. A matching contact is refused at enrollment with reason
suppressed, and a rep cannot override it. When an email step comes due, a matching address or domain opts the enrollment out instead of sending, and completing amanual_emailtask for one fails, with the reason in the task’serror_reason. A transactional sequence skips the enrollment check, but its emails are still not sent to an entry with reasonbounced,complainedordnc. - Idempotent by value. Adding a value already on the list returns the existing entry unchanged, including its original
reason.
Send a bare domain. A URL is reduced to its host but keeps any subdomain, so https://www.globex.com is stored as www.globex.com and matches only addresses at that host. Removing an entry later does not re-enroll anyone. Acts as user_id, who is recorded on the entry. Counts against the Sequencer writes rate limit.
What a value matches
Good to know
- Send a bare domain. A URL is reduced to its host but keeps its subdomain, so
https://www.globex.comblocks only addresses atwww.globex.com. - Adding a value that is already on the list returns the existing entry unchanged. Its original
reasonis kept. - A transactional sequence skips the enrollment check, but still never emails an entry with reason
bounced,complainedordnc. - To add many values, use Import suppression entries.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Headers
Makes this write safe to retry. Send a unique value, such as a UUID, and send the same value again when you retry the same request. A retry with the same key and the same request (method, path including the query string, and JSON body) returns the original successful response without acting twice. The same key with a different body or path returns 409, and so does a retry while the first request is still running; that one is safe to repeat after a moment. A request that fails frees its key, so a retry runs the write again: after a 5xx on a create, confirm with a GET before retrying. Keys are kept for 24 hours and are scoped to your team.
Body
The team member this call acts as. Must be an active member of the team the API key belongs to. Recorded on the entry.
"507f1f77bcf86cd799439011"
email blocks one address. domain blocks every address at the domain and its subdomains. phone blocks one number.
email, domain, phone What to block. Stored normalized: emails and domains lowercased; a domain may be sent as example.com, @example.com, a full address or a URL, and is reduced to its host (a www. prefix is kept, so send the bare domain); a phone number is reduced to its digits, and a North American number is stored without its leading 1. A value that is empty once normalized is refused.
320Why it is blocked. dnc is do-not-call. Defaults to manual. Recorded only when the value is new: an existing entry keeps its reason.
unsubscribed, bounced, complained, manual, dnc Response
The entry: the new one, or the existing entry for this value.
A do-not-contact entry.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
Team id.
email, domain, phone The normalized value: a lowercased email or domain, or a phone number's digits (North American numbers without the leading 1).
Why it is blocked. dnc is do-not-call.
unsubscribed, bounced, complained, manual, dnc How it was added: manual (dashboard or API), import, disposition (a do-not-call call outcome in the dialer), or the sending provider's identifier for an automatic bounce, complaint or unsubscribe.
The sequence that caused an automatic entry, when there was one.
The contact behind an automatic entry.
Who added it, for entries added by hand or imported.
When it was added.