List suppression entries

Lists suppression entries for a customer within a domain, optionally filtered by status.

This endpoint returns the raw list of matching entries only — it does not compute a
block/allow decision. Callers (e.g. a Journey Canvas step, right before an actual outbound
action) are responsible for interpreting the returned entries against their own context.

Required query parameters:

  • domain
  • brand

Optional query parameters:

  • status — when omitted, every entry is returned regardless of status. Pass ACTIVE to get
    only entries that currently block outbound contact (excludes REVOKED and naturally expired
    entries); pass REVOKED to get only revoked entries (expiry is not considered for this
    filter).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

erc-ecommerce-customers:read

Path Params
string
required
length between 1 and 255

The customer ID

Query Params
string
required
length ≥ 1

The business domain to list entries for (e.g. "recall_management", "cart_recovery").

string
required
length between 1 and 255

The brand of the provider. Used both to validate that customer_id is a known customer, and to scope which entries are returned — the same customer_id can belong to a different real customer under a different brand in a multi-brand account, so entries are never returned across brands.

string
enum
length between 1 and 20

Filters the result to entries with this status (case-insensitive — active and ACTIVE both work). Omit to return every entry regardless of status.

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json