Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | Uuid | Nem | The 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… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
connected | boolean | Igen | — |
id | string | Nem | — |
provider | string | Igen | — |
status | string<not_connected, unverified, verified, rejected> | Igen | — |
from_address | string | Nem | — |
from_local_part | string | Nem | — |
from_display_name | string | Nem | — |
sending_domain | string | Nem | — |
reply_to | string | Nem | — |
verified_domains | EspVerifiedDomain[] | Nem | — |
last_verified_at | string | Nem | — |
last_error | string | Nem | — |
stats | CampaignDeliveryCounts | Nem | ⛔ `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… |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403