Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | Uuid | Ne | 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 agency… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
connected | boolean | Ano | — |
id | string | Ne | — |
provider | string | Ano | — |
status | string<not_connected, unverified, verified, rejected> | Ano | — |
from_address | string | Ne | — |
from_local_part | string | Ne | — |
from_display_name | string | Ne | — |
sending_domain | string | Ne | — |
reply_to | string | Ne | — |
verified_domains | EspVerifiedDomain[] | Ne | — |
last_verified_at | string | Ne | — |
last_error | string | Ne | — |
stats | CampaignDeliveryCounts | Ne | ⛔ 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… |
Chyby, které může tento koncový bod vrátit
401 · 403