campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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>> }'

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

`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)`.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`org_id (query)`	`string`	Ne	—

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`email`	`string`	Da	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Da	—
`note`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`string`	Da	—
`email`	`string`	Da	—
`reason`	`string`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422