Hanzo
OpenapiMarketing

Returns the org's opt-out list, newest first — everyone the send gate will…

Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.

GET /v1/marketing/suppressions

Addresshttps://api.hanzo.ai/v1/marketing/suppressions
MethodGET
Operationget_marketing_suppressions
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.

Request

1 field.

FieldInTypeRequiredDescription
limitqueryintegerLimit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Response

StatusBodyMeaning
200SuppressionListok

200 body — 5 fields.

FieldInTypeAlwaysDescription
databodySuppression[]Data is the page: every (channel, address) this org's send gate refuses, newest opt-out first.
data[].addressbodystringAddress is the recipient, normalized (lower-cased, trimmed) so an opt-out cannot be slipped past on a case or whitespace difference.
data[].channelbodystringChannel is the surface opted out of: email, sms, social, meta, google or tiktok.
data[].createdAtbodyintegerCreatedAt is unix seconds, server-assigned.
data[].reasonbodystringReason is a free-text note, capped at 1024 bytes.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing suppressions get

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page