Skip to main content
POST
Add a suppression entry
Blocks an email address, a whole domain or a phone number. Anyone matching it is not enrolled, and is not emailed by a sequence they are already in.

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.com blocks only addresses at www.globex.com.
  • Adding a value that is already on the list returns the existing entry unchanged. Its original reason is kept.
  • A transactional sequence skips the enrollment check, but still never emails an entry with reason bounced, complained or dnc.
  • To add many values, use Import suppression entries.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Headers

Idempotency-Key
string

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

application/json
user_id
string
required

The team member this call acts as. Must be an active member of the team the API key belongs to. Recorded on the entry.

Example:

"507f1f77bcf86cd799439011"

type
enum<string>
required

email blocks one address. domain blocks every address at the domain and its subdomains. phone blocks one number.

Available options:
email,
domain,
phone
value
string
required

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.

Maximum string length: 320
reason
enum<string>
default:manual

Why it is blocked. dnc is do-not-call. Defaults to manual. Recorded only when the value is new: an existing entry keeps its reason.

Available options:
unsubscribed,
bounced,
complained,
manual,
dnc

Response

The entry: the new one, or the existing entry for this value.

A do-not-contact entry.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

team
string

Team id.

type
enum<string>
Available options:
email,
domain,
phone
value
string

The normalized value: a lowercased email or domain, or a phone number's digits (North American numbers without the leading 1).

reason
enum<string>

Why it is blocked. dnc is do-not-call.

Available options:
unsubscribed,
bounced,
complained,
manual,
dnc
source
string | null

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.

sequence
string

The sequence that caused an automatic entry, when there was one.

contact
string

The contact behind an automatic entry.

user
string

Who added it, for entries added by hand or imported.

created_at
string<date-time>

When it was added.

updated_at
string<date-time>