Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come campo nel corpo JSON.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
api_key | string | Sì | — |
from_local_part | string | No | — |
from_display_name | string | No | — |
sending_domain | string | No | — |
reply_to | string | No | — |
org_id | string | No | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
connected | boolean | Sì | — |
id | string | No | — |
provider | string | Sì | — |
status | string<not_connected, unverified, verified, rejected> | Sì | — |
from_address | string | No | — |
from_local_part | string | No | — |
from_display_name | string | No | — |
sending_domain | string | No | — |
reply_to | string | No | — |
verified_domains | EspVerifiedDomain[] | No | — |
last_verified_at | string | No | — |
last_error | string | No | — |
stats | CampaignDeliveryCounts | No | ⛔ `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… |
Errori che questo endpoint può restituire
401 · 403 · 422 · 503