Suppressions and bounces

/v1/transactional/bounces/statistics

GET/v1/transactional/bounces/statistics

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/bounces/statistics"

curl -X GET "https://example.com/v1/transactional/bounces/statistics"

{
  "data_source": "string",
  "fallback_reason": null,
  "is_degraded": true,
  "totalBounces": 0,
  "hardBounces": 0,
  "softBounces": 0,
  "generalBounces": 0,
  "platformIssueBounces": 0,
  "attemptsExpiredBounces": 0,
  "byCategory": {
    "property1": 0,
    "property2": 0
  }
}

{  "data_source": "string",  "fallback_reason": null,  "is_degraded": true,  "totalBounces": 0,  "hardBounces": 0,  "softBounces": 0,  "generalBounces": 0,  "platformIssueBounces": 0,  "attemptsExpiredBounces": 0,  "byCategory": {    "property1": 0,    "property2": 0  }}

Get recent bounced emails

GET/v1/transactional/bounces/recent

PERF: Limited to last 90 days to prevent full table scan. Date filter applied first for index usage.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/bounces/recent"

curl -X GET "https://example.com/v1/transactional/bounces/recent"

[
  {
    "messageId": "string",
    "recipientEmail": "string",
    "subject": "string",
    "bounceCategory": null,
    "categoryKey": "string",
    "bounceType": "string",
    "canRetry": true,
    "bounceReason": null,
    "bouncedAt": "2019-08-24T14:15:22Z",
    "retryCount": 0
  }
]

[  {    "messageId": "string",    "recipientEmail": "string",    "subject": "string",    "bounceCategory": null,    "categoryKey": "string",    "bounceType": "string",    "canRetry": true,    "bounceReason": null,    "bouncedAt": "2019-08-24T14:15:22Z",    "retryCount": 0  }]

D-312 (1) — messages a provider refused because of the platform's own sending IP, shown APART from the customer's bounces. Deliberately carries no provider text, no category and no retry: the reason names our sending address (D-312 (3)), and nothing the customer can do cures it.

GET/v1/transactional/bounces/platform-issues

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/bounces/platform-issues"

curl -X GET "https://example.com/v1/transactional/bounces/platform-issues"

[
  {
    "messageId": "string",
    "recipientEmail": "string",
    "subject": "string",
    "occurredAt": "2019-08-24T14:15:22Z"
  }
]

[  {    "messageId": "string",    "recipientEmail": "string",    "subject": "string",    "occurredAt": "2019-08-24T14:15:22Z"  }]

MessageExpired option 3 — messages whose delivery attempts expired (the MTA gave up after its retry window). Still `Bounced` in the status, with the webhook and suppression behaviour unchanged, but not this tenant's bounce, so they are listed here instead of in `recent`, in no bounce count, rate or Sender Score. A neutral group: no provider text, no category; the customer may send the message again.

GET/v1/transactional/bounces/attempts-expired

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/bounces/attempts-expired"

curl -X GET "https://example.com/v1/transactional/bounces/attempts-expired"

[
  {
    "messageId": "string",
    "recipientEmail": "string",
    "subject": "string",
    "occurredAt": "2019-08-24T14:15:22Z"
  }
]

[  {    "messageId": "string",    "recipientEmail": "string",    "subject": "string",    "occurredAt": "2019-08-24T14:15:22Z"  }]

D-315 (3) / UNG-646 - the expired group broken down by observed cause (mailbox full, receiving server unreachable, temporarily rate-limited by the provider, unknown) and by recipient domain with repeat counts, so that excluding expiries from the bounce rate cannot hide a dead domain or a full mailbox. Counts only: no address, no provider text.

GET/v1/transactional/bounces/attempts-expired/summary

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

from?string

Formatdate-time

to?string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/bounces/attempts-expired/summary"

curl -X GET "https://example.com/v1/transactional/bounces/attempts-expired/summary"

{
  "total": 0,
  "truncated": true,
  "byCause": [
    {
      "cause": "string",
      "count": 0
    }
  ],
  "byDomain": [
    {
      "domain": "string",
      "expired": 0,
      "recipients": 0,
      "repeatRecipients": 0,
      "lastExpiredAt": "2019-08-24T14:15:22Z",
      "cause": "string"
    }
  ]
}

{  "total": 0,  "truncated": true,  "byCause": [    {      "cause": "string",      "count": 0    }  ],  "byDomain": [    {      "domain": "string",      "expired": 0,      "recipients": 0,      "repeatRecipients": 0,      "lastExpiredAt": "2019-08-24T14:15:22Z",      "cause": "string"    }  ]}

/v1/transactional/bounces/{messageId}/retry

POST/v1/transactional/bounces/{messageId}/retry

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

messageId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/bounces/string/retry"

curl -X POST "https://example.com/v1/transactional/bounces/string/retry"

{
  "message": "string"
}

{  "message": "string"}

List suppression entries with scope filtering

GET/v1/transactional/suppressions

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

cursor?string

search?string

type?string

Value in

"hardBounce"
"softBounce"
"complaint"
"unsubscribe"
"manual"
"invalid"
"spamTrap"
"roleAddress"

scope?string

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?string

fromDate?string

Formatdate-time

toDate?string

Formatdate-time

sortBy?string

Default"CreatedAt"

sortDescending?boolean

Defaulttrue

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/suppressions"

curl -X GET "https://example.com/v1/transactional/suppressions"

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "suppressionType": "hardBounce",
      "suppressionTypeName": null,
      "scope": "global",
      "scopeName": null,
      "mailingListId": null,
      "mailingListName": null,
      "expiresAt": null,
      "reason": null,
      "reasonCode": null,
      "bounceType": null,
      "bounceCategory": null,
      "bounceSubcategory": null,
      "bounceCount": 0,
      "lastBounceAt": null,
      "unsubscribeSource": null,
      "unsubscribeSourceName": null,
      "campaignId": null,
      "subscriberId": null,
      "messageId": null,
      "source": null,
      "ipAddress": null,
      "notes": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": null,
      "isLocked": true,
      "lockedReason": null
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "email": "string",      "suppressionType": "hardBounce",      "suppressionTypeName": null,      "scope": "global",      "scopeName": null,      "mailingListId": null,      "mailingListName": null,      "expiresAt": null,      "reason": null,      "reasonCode": null,      "bounceType": null,      "bounceCategory": null,      "bounceSubcategory": null,      "bounceCount": 0,      "lastBounceAt": null,      "unsubscribeSource": null,      "unsubscribeSourceName": null,      "campaignId": null,      "subscriberId": null,      "messageId": null,      "source": null,      "ipAddress": null,      "notes": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": null,      "isLocked": true,      "lockedReason": null    }  ],  "nextCursor": null,  "hasMore": true}

Add single email to suppression list with scope

POST/v1/transactional/suppressions

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

suppressionType?SuppressionType

Value in

"hardBounce"
"softBounce"
"complaint"
"unsubscribe"
"manual"
"invalid"
"spamTrap"
"roleAddress"

scope?SuppressionScope

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?null|string

reason?null|string

notes?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string"
  }'

curl -X POST "https://example.com/v1/transactional/suppressions" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'

{
  "id": "string",
  "email": "string",
  "suppressionType": "hardBounce",
  "suppressionTypeName": null,
  "scope": "global",
  "scopeName": null,
  "mailingListId": null,
  "mailingListName": null,
  "expiresAt": null,
  "reason": null,
  "reasonCode": null,
  "bounceType": null,
  "bounceCategory": null,
  "bounceSubcategory": null,
  "bounceCount": 0,
  "lastBounceAt": null,
  "unsubscribeSource": null,
  "unsubscribeSourceName": null,
  "campaignId": null,
  "subscriberId": null,
  "messageId": null,
  "source": null,
  "ipAddress": null,
  "notes": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": null,
  "isLocked": true,
  "lockedReason": null
}

{  "id": "string",  "email": "string",  "suppressionType": "hardBounce",  "suppressionTypeName": null,  "scope": "global",  "scopeName": null,  "mailingListId": null,  "mailingListName": null,  "expiresAt": null,  "reason": null,  "reasonCode": null,  "bounceType": null,  "bounceCategory": null,  "bounceSubcategory": null,  "bounceCount": 0,  "lastBounceAt": null,  "unsubscribeSource": null,  "unsubscribeSourceName": null,  "campaignId": null,  "subscriberId": null,  "messageId": null,  "source": null,  "ipAddress": null,  "notes": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": null,  "isLocked": true,  "lockedReason": null}

Get suppression statistics

GET/v1/transactional/suppressions/stats

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/suppressions/stats"

curl -X GET "https://example.com/v1/transactional/suppressions/stats"

{
  "totalCount": 0,
  "globalCount": 0,
  "marketingCount": 0,
  "transactionalCount": 0,
  "listCount": 0,
  "hardBounceCount": 0,
  "softBounceCount": 0,
  "complaintCount": 0,
  "unsubscribeCount": 0,
  "manualCount": 0,
  "invalidCount": 0,
  "spamTrapCount": 0,
  "roleAddressCount": 0,
  "expiringCount": 0,
  "lastSuppression": null
}

{  "totalCount": 0,  "globalCount": 0,  "marketingCount": 0,  "transactionalCount": 0,  "listCount": 0,  "hardBounceCount": 0,  "softBounceCount": 0,  "complaintCount": 0,  "unsubscribeCount": 0,  "manualCount": 0,  "invalidCount": 0,  "spamTrapCount": 0,  "roleAddressCount": 0,  "expiringCount": 0,  "lastSuppression": null}

Get suppression count with optional filters

GET/v1/transactional/suppressions/count

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

type?string

Value in

"hardBounce"
"softBounce"
"complaint"
"unsubscribe"
"manual"
"invalid"
"spamTrap"
"roleAddress"

scope?string

Value in

"global"
"marketing"
"transactional"
"list"

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/suppressions/count"

curl -X GET "https://example.com/v1/transactional/suppressions/count"

null

null

Bulk add emails to suppression list

POST/v1/transactional/suppressions/bulk

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emails*array<>

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions/bulk" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      {
        "email": "string"
      }
    ]
  }'

curl -X POST "https://example.com/v1/transactional/suppressions/bulk" \  -H "Content-Type: application/json" \  -d '{    "emails": [      {        "email": "string"      }    ]  }'

{
  "totalCount": 0,
  "addedCount": 0,
  "skippedCount": 0,
  "skippedEmails": [
    "string"
  ],
  "message": "string"
}

{  "totalCount": 0,  "addedCount": 0,  "skippedCount": 0,  "skippedEmails": [    "string"  ],  "message": "string"}

Remove suppression by ID

DELETE/v1/transactional/suppressions/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/transactional/suppressions/string"

curl -X DELETE "https://example.com/v1/transactional/suppressions/string"

Empty

Remove suppression by email with optional scope filter

DELETE/v1/transactional/suppressions/by-email

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

email?string

scope?string

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/transactional/suppressions/by-email"

curl -X DELETE "https://example.com/v1/transactional/suppressions/by-email"

Empty

Check if single email is suppressed

GET/v1/transactional/suppressions/check

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

email?string

messageType?string

Default1

Value in

"transactional"
"marketing"

mailingListId?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/suppressions/check"

curl -X GET "https://example.com/v1/transactional/suppressions/check"

null

null

Legacy: Check if emails are suppressed (Global scope only)

POST/v1/transactional/suppressions/check

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emails*array<string>

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions/check" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      "string"
    ]
  }'

curl -X POST "https://example.com/v1/transactional/suppressions/check" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "string"    ]  }'

{
  "results": {
    "property1": true,
    "property2": true
  }
}

{  "results": {    "property1": true,    "property2": true  }}

Bulk check if emails are suppressed

POST/v1/transactional/suppressions/check-bulk

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emails*array<string>

messageType?MessageType

Value in

"transactional"
"marketing"

mailingListId?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions/check-bulk" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      "string"
    ]
  }'

curl -X POST "https://example.com/v1/transactional/suppressions/check-bulk" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "string"    ]  }'

{
  "suppressedEmails": [
    "string"
  ]
}

{  "suppressedEmails": [    "string"  ]}

Import suppressions from CSV with scope support

POST/v1/transactional/suppressions/import

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

csvContent*string

defaultReason?null|string

suppressionType?SuppressionType

Value in

"hardBounce"
"softBounce"
"complaint"
"unsubscribe"
"manual"
"invalid"
"spamTrap"
"roleAddress"

scope?SuppressionScope

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions/import" \
  -H "Content-Type: application/json" \
  -d '{
    "csvContent": "string"
  }'

curl -X POST "https://example.com/v1/transactional/suppressions/import" \  -H "Content-Type: application/json" \  -d '{    "csvContent": "string"  }'

{
  "totalRows": 0,
  "importedCount": 0,
  "skippedCount": 0,
  "invalidCount": 0,
  "invalidEmails": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "message": "string"
}

{  "totalRows": 0,  "importedCount": 0,  "skippedCount": 0,  "invalidCount": 0,  "invalidEmails": [    "string"  ],  "errors": [    "string"  ],  "message": "string"}

Import suppressions from CSV file

POST/v1/transactional/suppressions/import-file

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

scope?string

Default0

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?IFormFile

Formatbinary

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/suppressions/import-file"

curl -X POST "https://example.com/v1/transactional/suppressions/import-file"

{
  "totalRows": 0,
  "importedCount": 0,
  "skippedCount": 0,
  "invalidCount": 0,
  "invalidEmails": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "message": "string"
}

{  "totalRows": 0,  "importedCount": 0,  "skippedCount": 0,  "invalidCount": 0,  "invalidEmails": [    "string"  ],  "errors": [    "string"  ],  "message": "string"}

Export suppressions as CSV with scope filter

GET/v1/transactional/suppressions/export

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

type?string

Value in

"hardBounce"
"softBounce"
"complaint"
"unsubscribe"
"manual"
"invalid"
"spamTrap"
"roleAddress"

scope?string

Value in

"global"
"marketing"
"transactional"
"list"

mailingListId?string

Response Body

`text/csv`

curl -X GET "https://example.com/v1/transactional/suppressions/export"

curl -X GET "https://example.com/v1/transactional/suppressions/export"

{
  "fileContents": "string",
  "contentType": null,
  "fileDownloadName": null,
  "lastModified": null,
  "entityTag": null,
  "enableRangeProcessing": true
}

{  "fileContents": "string",  "contentType": null,  "fileDownloadName": null,  "lastModified": null,  "entityTag": null,  "enableRangeProcessing": true}

Suppressions and bounces

/v1/transactional/bounces/statisticsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Get recent bounced emailsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

D-312 (1) — messages a provider refused because of the platform's own sending IP, shown APART from the customer's bounces. Deliberately carries no provider text, no category and no retry: the reason names our sending address (D-312 (3)), and nothing the customer can do cures it.Copy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

/v1/transactional/bounces/{messageId}/retryCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

List suppression entries with scope filteringCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

Add single email to suppression list with scopeCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

404application/json

Get suppression statisticsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Get suppression count with optional filtersCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Bulk add emails to suppression listCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

Remove suppression by IDCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

403application/json

404application/json

Remove suppression by email with optional scope filterCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

404application/json

Check if single email is suppressedCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Legacy: Check if emails are suppressed (Global scope only)Copy Anchor Link

AuthorizationCopy Anchor Link

/v1/transactional/bounces/statistics

Authorization

Query Parameters

Response Body

`application/json`

Get recent bounced emails

Authorization

Query Parameters

Response Body

`application/json`

D-312 (1) — messages a provider refused because of the platform's own sending IP, shown APART from the customer's bounces. Deliberately carries no provider text, no category and no retry: the reason names our sending address (D-312 (3)), and nothing the customer can do cures it.

Authorization

Query Parameters

Response Body

`application/json`

Authorization

Query Parameters

Response Body

`application/json`

Authorization

Query Parameters

Response Body

`application/json`

/v1/transactional/bounces/{messageId}/retry

Authorization

Path Parameters

Response Body

`application/json`

List suppression entries with scope filtering

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Add single email to suppression list with scope

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Get suppression statistics

Authorization

Response Body

`application/json`

Get suppression count with optional filters

Authorization

Query Parameters

Response Body

`application/json`

Bulk add emails to suppression list

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Remove suppression by ID

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Remove suppression by email with optional scope filter

Authorization

Query Parameters

Response Body

`application/json`

Check if single email is suppressed

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

Legacy: Check if emails are suppressed (Global scope only)

Authorization

Request Body

Response Body

`application/json`