Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Body

application/json
emails
string<email>[]
required

The addresses to suppress.

Example:
scope
enum<string>
default:global

The scope applied to every address in this request. global (the default) blocks all sends. marketing or transactional block only that stream once your account's suppression policy is set to stream-scoped (Settings → Suppression); under the default account-wide policy every entry blocks all sends regardless of scope. An omitted or unrecognised value falls back to global — a suppression is never silently narrowed.

Available options:
global,
marketing,
transactional

Response

OK

added
integer

Addresses newly added to the list.

skipped
integer

Addresses that were already suppressed.

duplicates
integer

Addresses that appeared more than once in this request.

data
object[]