Suppressions

Every Suppressions endpoint.

GET/v1/suppressions

List suppressed addresses

Addresses this tenant will never send to. `reason` filters on `HARD_BOUNCE`/`COMPLAINT`/`UNSUBSCRIBE`/`MANUAL`; `search` matches the address.

Auth: apiKey or jwt

Parameters

Name	In	Required
page	query	optional
limit	query	optional
reason	query	optional
search	query	optional

Responses

200 : Default Response

Field	Type	Required
data	array	required
data[].created_at	string	required · nullable
data[].email	string	required
data[].id	string	required
data[].reason	string	required
data[].source	string	required
pagination.limit	number	required
pagination.page	number	required
pagination.pages	number	required
pagination.total	number	required

curl

curl https://api.zsender.io/v1/suppressions \
  -H "Authorization: Bearer $ZSENDER_API_KEY"

POST/v1/suppressions

Suppress an address

Adds `email` to the suppression list; `reason` defaults to `MANUAL`. A live-mode key only; a test key is refused `403`.

Auth: apiKey or jwt

Request body

Field	Type	Required	Description
email	string	required
reason	string	optional

Example request body

{
  "email": "maria.santos@example.com",
  "reason": "MANUAL"
}

Responses

201 : Default Response

Field	Type	Required
created_at	string	required · nullable
email	string	required
id	string	required
reason	string	required
source	string	required

curl

curl https://api.zsender.io/v1/suppressions \
  -X POST \
  -H "Authorization: Bearer $ZSENDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "maria.santos@example.com",
  "reason": "MANUAL"
}'

DELETE/v1/suppressions/{email}

Remove an address from the suppression list

`deleted` is `0` if the address was not suppressed, `1` if it was removed. A live-mode key only; a test key is refused `403`.

Auth: apiKey or jwt

Parameters

Name	In	Required	Description
email	path	required

Responses

200 : Default Response

Field	Type	Required	Description
deleted	number	required

curl

curl https://api.zsender.io/v1/suppressions/{email} \
  -X DELETE \
  -H "Authorization: Bearer $ZSENDER_API_KEY"

GET/v1/suppressions/{email}

Look up one address

Answers `200` either way: `{suppressed: false}` for an address that is not suppressed, never a `404`.

Auth: apiKey or jwt

Parameters

Name	In	Required	Description
email	path	required

Responses

200 : Default Response

Field	Type	Required
(1).suppressed	boolean	required
(2).created_at	string	required · nullable
(2).email	string	required
(2).id	string	required
(2).reason	string	required
(2).source	string	required
(2).suppressed	boolean	required

curl

curl https://api.zsender.io/v1/suppressions/{email} \
  -H "Authorization: Bearer $ZSENDER_API_KEY"