Skip to main content
POST
Add a suppression entry
Adds one address, domain or phone number to the do-not-contact list. Anyone matching is refused at enrolment with reason suppressed, and cannot be force-included — an opt-out is not a judgement call.

Authorizations

x-api-key
string
header
required

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

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.

Example:

"507f1f77bcf86cd799439011"

type
enum<string>
required
Available options:
email,
domain,
phone
value
string
required
reason
enum<string>
default:manual
Available options:
unsubscribed,
bounced,
complained,
manual,
dnc

Response

Success.

A do-not-contact entry.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

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

Stored normalised.

reason
enum<string>
Available options:
unsubscribed,
bounced,
complained,
manual,
dnc
source
string | null
created_at
string<date-time>

When it was added.