campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`org_id (query)`	`string`	Tidak	—

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`email`	`string`	Ya	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Ya	—
`note`	`string`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`string`	Ya	—
`email`	`string`	Ya	—
`reason`	`string`	Ya	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 422