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 memerlukan org_id sebagai field dalam bodi JSON.
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/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'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
The key is written to Vault and never to the database. Connecting resets the connection to unverified — a new key behind an old "verified" badge is a connection claiming a proof it does not have.
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
api_key | string | Ya | — |
from_local_part | string | Tidak | — |
from_display_name | string | Tidak | — |
sending_domain | string | Tidak | — |
reply_to | string | Tidak | — |
org_id | string | Tidak | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
connected | boolean | Ya | — |
id | string | Tidak | — |
provider | string | Ya | — |
status | string<not_connected, unverified, verified, rejected> | Ya | — |
from_address | string | Tidak | — |
from_local_part | string | Tidak | — |
from_display_name | string | Tidak | — |
sending_domain | string | Tidak | — |
reply_to | string | Tidak | — |
verified_domains | EspVerifiedDomain[] | Tidak | — |
last_verified_at | string | Tidak | — |
last_error | string | Tidak | — |
stats | CampaignDeliveryCounts | Tidak | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 422 · 503