Suppressions

List suppressions

The do-not-send list, newest first, cursor-paginated. Filter by reason to separate hard bounces from complaints, unsubscribes, and manual blocks.

Every send checks this list first, and a suppressed recipient comes back inside a 200 as { to, skipped: "suppressed" } rather than as an error — so a caller reading messages as "delivered" counts suppressions as successes.

To ask about a single address rather than page the whole list, use GET /v1/suppressions/check.

get/v1/suppressions

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/suppressions
  • Auth: HTTP bearer

Query parameters

cursorstring

Pagination cursor — an OPAQUE token. Take the nextCursor from the previous page and send it back unchanged. Do not parse it, do not coerce it to a number, and do not construct one: the format is <unixMs>.<objectId> today and may change. A cursor that cannot be parsed is rejected with 422 validation_error rather than silently restarting at page one.

limitinteger

Page size (1–200, default 50).

reason'hard_bounce' | 'complaint' | 'manual' | 'unsubscribe'

Response

A page of suppressions.

nextCursorstring nullable required

Opaque token. Pass back as cursor verbatim to fetch the next page; null when there are no more rows.

Changes

No recorded changes to this operation across all 1 revision of this API.