campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.

Πού μπαίνει το αναγνωριστικό του οργανισμού σας

Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.

Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

curl -X POST https://api.zinndigital.com/v1/campaigns/suppressions \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "reason": <string<unsubscribed, bounced, complained, staff_blocked>> }'

Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API

Λεπτομέρειες

`unsubscribed` applies to your own campaigns. `bounced`, `complained` and `staff_blocked` are facts about the ADDRESS and are stored platform-wide whatever scope you send them under — continuing to mail a hard bounce damages delivery for every other customer sending from the same domain. Idempotent on `(scope, address, purpose)`.

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`org_id (query)`	`string`	Όχι	—

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`email`	`string`	Ναι	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Ναι	—
`note`	`string`	Όχι	—

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`id`	`string`	Ναι	—
`email`	`string`	Ναι	—
`reason`	`string`	Ναι	—

Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο

401 · 403 · 422

POST /v1/campaigns/suppressions