Campaigns

POST /v1/campaigns/esp/verify

Prove the provider account works and read its verified domains.

Alle Campaigns-eindpunten

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 verwacht org_id als een veld in de JSON-body.

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 POST https://api.zinndigital.com/v1/campaigns/esp/verify \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

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.

Aanvraaglichaam

NaamTypeVerplichtWat dit is
org_idstringNee

Reactie

NaamTypeVerplichtWat dit is
connectedbooleanJa
idstringNee
providerstringJa
statusstring<not_connected, unverified, verified, rejected>Ja
from_addressstringNee
from_local_partstringNee
from_display_namestringNee
sending_domainstringNee
reply_tostringNee
verified_domainsEspVerifiedDomain[]Nee
last_verified_atstringNee
last_errorstringNee
statsCampaignDeliveryCountsNee⛔ `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 · 422