Hoppa till innehållet

Referens / Spärrlista

Lista spärrade adresser

GET/api/v1/suppressions

Arbetsytans spärrlista, en sida i taget. Bra för att hålla en webbutik i takt med avregistreringar.

Behörighet

  • contacts:read Läsa kontakter – personen bakom nyckeln måste vara alla medlemmar.

Query-parametrar

limitinteger
Hur många som högst ska komma i svaret (1–500, standard 100).minst 1 · högst 500 · standard 100
cursorstring
next_cursor från förra svaret, för nästa sida. Utelämna för första sidan.
reasonstring
Bara spärrar av det slaget.unsubscribedbouncedcomplainedmanualimported

Svar

200 En sida spärrade adresser.

dataarray<object>krävs
data[].emailstringkrävs
data[].reasonstringkrävs
unsubscribed, bounced, complained, manual eller imported.
data[].detailstring | nullkrävs
data[].created_atstring (tid, ISO 8601)krävs
När adressen spärrades.
data[].contact_idstring | nullkrävs
Kontakten med adressen, om det finns en som nyckeln får se.
has_morebooleankrävs
Det finns fler: hämta nästa sida med cursor=next_cursor.
next_cursorstring | nullkrävs
Skicka som cursor för nästa sida. null på sista sidan.

Fel