mail-suppressions

Stable. Describes behaviour that is built and covered by tests in this repository.

GET `/v1/mail-suppressions` #

The addresses the tenant's mail is not sent to

An address lands here when its mail bounced for good, drew a complaint, or the operator put it here by hand. Mail to it is dropped as done, whatever the mail is. In address order, a page at a time (page_size 1 to 500, default 50; next_page_token is empty on the last page). On a deployment whose gateway is not connected to the notifier the answer is 200 with an empty list and connected false (lifting an address, which is an action, answers 503 gateway.mail.unavailable there).

Parameters

Name	In	Type	Description
`page_size`	query	integer
`page_token`	query	string

Responses

Status	Meaning	Body
`200`	OK	ListMailSuppressionsResponse
`400`	Error envelope	Error
`503`	Error envelope	Error

Example response

{
  "suppressions": [
    {
      "address": "string",
      "reason": "bounce",
      "detail": "string",
      "create_time": "2026-11-03T10:15:00Z"
    }
  ],
  "next_page_token": "string",
  "connected": false
}

curl

curl -X GET https://YOUR-API-ADDRESS/v1/mail-suppressions \
  -H "Authorization: Bearer $PAYRUDDER_API_KEY"

DELETE `/v1/mail-suppressions/{address}` #

Mail an address again

Lifts the suppression of one address. Lifting an address that is not on the list is 404 gateway.mail.suppression_not_found. An address that bounces again is put back by that bounce.

Parameters

Name	In	Type	Description
`address` required	path	string

Responses

Status	Meaning	Body
`204`	Lifted
`400`	Error envelope	Error
`404`	Error envelope	Error
`503`	Error envelope	Error

curl

curl -X DELETE https://YOUR-API-ADDRESS/v1/mail-suppressions/<address> \
  -H "Authorization: Bearer $PAYRUDDER_API_KEY"

Models

Error

Field	Type	Description
`error` required	object

ListMailSuppressionsResponse

Field	Type	Description
`suppressions` required	array of MailSuppression
`next_page_token` required	string
`connected` required	boolean	False when this deployment's gateway is not connected to the notifier (the list is then empty because nothing was asked, not because nothing is suppressed).