Skip to main content
POST
Preview adding do-not-contact entries

Authorizations

X-API-Key
string
header
required

Body

application/json
values
string[]
required

Addresses and domains, one per item. A value containing @ suppresses one address; a bare domain suppresses everyone at it.

Required array length: 1 - 10000 elements
Required string length: 1 - 320
stop_live_sequences
boolean
default:false

Also stop everyone the values reach in every live sequence, reading Do not contact. Off, they stay where they are and the send check stops them one step at a time.

Response

Successful Response

own_domains
string[]
required

Whole domains among the values that this workspace itself mails from.

personal_email_providers
string[]
required

Whole domains among the values that are personal email providers.

sequence_names
string[]
required

The sequences holding them, by name; empty without stop_live_sequences.

stopped
integer
required

How many live places in sequences the add would stop; 0 without stop_live_sequences.