Suppressions
Addresses we will not send to.
| Method | Path | Summary |
|---|---|---|
GET | /v0/suppressions | List Suppressions |
POST | /v0/suppressions | Add Suppression |
GET | /v0/suppressions/{email} | Get Suppression |
DELETE | /v0/suppressions/{email} | Remove Suppression |
List Suppressions
Every suppressed address in the organization (also for pod and inbox credentials). Addresses are added automatically on permanent bounces and complaints.
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: list_entry_read.
Query parameters
limitintegerpage_tokenstringascendingbooleanResponse
200 A page of suppressions (application/json)
countintegerRequiredlimitintegernext_page_tokenstringEach item of suppressions is a Suppression:
emailstringRequiredorganization_idstringRequiredreason"bounce" | "complaint" | "manual"Requireddetailstringsource_message_idstringcreated_atstring (date-time)RequiredErrors
| Status | Meaning |
|---|---|
400 | Invalid request: error.type is validation and error.param names the field. |
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
500 | Unexpected server error. |
Error bodies use the error envelope.
Example
Add Suppression
Suppress an address for the whole organization, with reason: "manual". Adding an address that is already suppressed replaces a bounce or manual suppression (its reason becomes manual); a complaint suppression is returned unchanged. Sends to a suppressed address return 403.
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: list_entry_create.
Request body
Content type: application/json.
emailstringRequireddetailstringreasonstringDeprecatedResponse
201 Created (application/json)
emailstringRequiredorganization_idstringRequiredreason"bounce" | "complaint" | "manual"Requireddetailstringsource_message_idstringcreated_atstring (date-time)RequiredErrors
| Status | Meaning |
|---|---|
400 | Invalid request: error.type is validation and error.param names the field. |
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
500 | Unexpected server error. |
Error bodies use the error envelope.
Example
Get Suppression
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: list_entry_read.
Path parameters
emailstringRequiredResponse
200 The suppression (application/json)
emailstringRequiredorganization_idstringRequiredreason"bounce" | "complaint" | "manual"Requireddetailstringsource_message_idstringcreated_atstring (date-time)RequiredErrors
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
404 | Not found. Also returned for resources outside the credential scope. |
500 | Unexpected server error. |
Error bodies use the error envelope.
Example
Remove Suppression
Allow sending to the address again. Organization-scoped credentials only: pod and inbox credentials get 403. Only bounce and manual suppressions can be removed: a complaint suppression returns 403 (Complaint suppressions can only be removed by MachineMail support; email support@machinemail.dev).
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: list_entry_delete.
Path parameters
emailstringRequiredResponse
200 Deleted (application/json)
oktrueRequiredErrors
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
404 | Not found. Also returned for resources outside the credential scope. |
500 | Unexpected server error. |
Error bodies use the error envelope.