Campaigns
POST /v1/campaigns/esp/verify
Prove the provider account works and read its verified domains.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet endpoint prend org_id comme champ dans le corps JSON.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp/verify \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
A real call to the provider. Configured is not proved — a connection is unusable until this has succeeded, and the response distinguishes "not connected" from "unverified" from "rejected" so the operator knows which one they are in.
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id | string | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
connected | boolean | Oui | — |
id | string | Non | — |
provider | string | Oui | — |
status | string<not_connected, unverified, verified, rejected> | Oui | — |
from_address | string | Non | — |
from_local_part | string | Non | — |
from_display_name | string | Non | — |
sending_domain | string | Non | — |
reply_to | string | Non | — |
verified_domains | EspVerifiedDomain[] | Non | — |
last_verified_at | string | Non | — |
last_error | string | Non | — |
stats | CampaignDeliveryCounts | Non | ⛔ `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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422