MailerCheckSuppression¶

GET mailer/suppression/check

Checks one address: is it valid, is it suppressed, and — for the class of email being sent — would sending be blocked.

It also answers the questions that save a bounce before it happens: is this a role mailbox (info@, admin@), a disposable domain, or a likely typo of a well-known provider. A suggestion for gmial.com costs nothing here and saves a hard bounce later.

Access Control¶

Allowed roles: admin, leader, manager.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/suppression/[email protected]&kind=MARKETING
Authorization: <JWT_TOKEN>

{
  "command": "MailerCheckSuppression",
  "extID": "1",
  "data": {
    "email": "[email protected]",
    "kind": "MARKETING"
  }
}

const res = await platform.MailerCheckSuppression({
  email: "[email protected]",
  kind: "MARKETING"
});

Request Data¶

Field	Type	Required	Description
`email`	string	Yes	Address to check
`kind`	enum	No	`MARKETING` (default) or `TRANSACTIONAL` — an unsubscribe blocks only marketing

Response Data¶

Verdict reasons: SUSPECTED_TYPO, ROLE_ADDRESS, DISPOSABLE_DOMAIN, plus the syntax ones. For a suppressed address suppression carries the reason, the source and when it was added — so the UI can say why the address is blocked, not just that it is.

{
  "email": "[email protected]",
  "valid": false,
  "reason": "SUSPECTED_TYPO",
  "suggestion": "[email protected]",
  "role": false,
  "disposable": false,
  "suppressed": false,
  "suppression": null
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Address is too short to be an address