Campaigns

DELETE /v1/campaigns/esp

Disconnect the provider account and remove its stored key.

Semua titik akhir Campaigns

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 DELETE https://api.zinndigital.com/v1/campaigns/esp \
  -H "Authorization: Bearer zdk_live_…"

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

Forget this organisation's e-mail provider. The stored key is removed from Vault, not merely hidden — and campaigns refuse to send until a provider is connected again.

Parameter

NamaJenisWajibTentang apa ini
org_id (query)UuidTidakThe organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen…

Tanggapan

NamaJenisWajibTentang apa ini
connectedbooleanYa
idstringTidak
providerstringYa
statusstring<not_connected, unverified, verified, rejected>Ya
from_addressstringTidak
from_local_partstringTidak
from_display_namestringTidak
sending_domainstringTidak
reply_tostringTidak
verified_domainsEspVerifiedDomain[]Tidak
last_verified_atstringTidak
last_errorstringTidak
statsCampaignDeliveryCountsTidak⛔ `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