Suppressions

Look up one address or suppression

Path form of GET /v1/suppressions/check, accepting either a suppression id or a URL-encoded email address.

Use it as a pre-send check. Note that a clean result here does not by itself mean a send will go out: POST /v1/send also skips a recipient whose contact is unsubscribed (skipped: "unsubscribed"), which is a different record from a suppression.

get/v1/suppressions/{id}

Request

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

Path parameters

idstring required

Suppression id, or a URL-encoded email address.

Response

Whether the address is suppressed. Not being suppressed is a 200, not a 404 — a 404 would be ambiguous with a missing route.

suppressedboolean required

Changes

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