Check if an email is in the suppression list

Check if an email is in the suppression list.

Note: The email address is not a part of the URL path so
as to avoid any PII data in the access logs.

post
http://mailbox-api.mailbox.svc.cluster.local:5600/v1/internal/email/suppression-list/check

Body

application/json

Body of suppression check request

EmailQuery

emailstring(email)required

The email address to check against the suppression list.

Example:user@example.com

Response

200 application/json

Response of email suppression check request

EmailSuppressionStateResponsePayload

emailstring(email)required

The email address to check against the suppression list.

Example:user@example.com

is_suppressedbooleanrequired

True if the email is in the suppression list, false otherwise.

Example:true

identifiersarray[object]

Kong Identifiers which are associated with this suppressed email entry.

Show Child Parameters
post/internal/email/suppression-list/check

Body

{ "email": "user@example.com" }
 
200 application/json

Remove the email from the suppression list

Remove the email from the suppression list.

Note: The email address is not a part of the URL path so
as to avoid any PII data in the access logs.

post
http://mailbox-api.mailbox.svc.cluster.local:5600/v1/internal/email/suppression-list/remove

Body

application/json

Body of remove email from suppression list

EmailQuery

emailstring(email)required

The email address to check against the suppression list.

Example:user@example.com

Response

204

No Content

post/internal/email/suppression-list/remove

Body

{ "email": "user@example.com" }
 
204

Identifier

object
principal_typestring

Type of the principal

Example:user

org_idstring

ID of the Organization which the principal belongs to.

Example:bc7e7998-b46b-4b3b-adbe-a4f761c408f3

principal_idstring(uuid)

Identifier of the associated principal

Example:5a568c6a-8121-4800-86dc-aac15ce3970e

Example

EmailQuery

object
emailstring(email)required

The email address to check against the suppression list.

Example:user@example.com

Example

EmailSuppressionStateResponsePayload

object
emailstring(email)required

The email address to check against the suppression list.

Example:user@example.com

is_suppressedbooleanrequired

True if the email is in the suppression list, false otherwise.

Example:true

identifiersarray[object]

Kong Identifiers which are associated with this suppressed email entry.

Show Child Parameters
Example