Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id (query) | Uuid | Nee | 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… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
connected | boolean | Ja | — |
id | string | Nee | — |
provider | string | Ja | — |
status | string<not_connected, unverified, verified, rejected> | Ja | — |
from_address | string | Nee | — |
from_local_part | string | Nee | — |
from_display_name | string | Nee | — |
sending_domain | string | Nee | — |
reply_to | string | Nee | — |
verified_domains | EspVerifiedDomain[] | Nee | — |
last_verified_at | string | Nee | — |
last_error | string | Nee | — |
stats | CampaignDeliveryCounts | Nee | ⛔ `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… |
Fouten die dit eindpunt kan retourneren
401 · 403