Skip to main content
POST
email.suppressions.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
category
enum<string>
required

The reason category; unsupported categories are refused.

Available options:
bounce,
complaint,
unsubscribe,
block,
invalid,
allow
scope
string

Optional sending domain or list scope. Never an account identifier.

Required string length: 1 - 253
limit
number

Page size, 1–100; default 20.

Required range: x >= 1
cursor
string

Opaque next-page cursor from this same query.

Required string length: 1 - 1024

Response

The result

results
object[]
required

Suppressed email addresses in your sending area.

nextCursor
string

Next-page cursor; absent on the last page.