Campaigns
POST /v1/campaigns/esp/verify
Prove the provider account works and read its verified domains.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp/verify \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
connected | boolean | Yes | — |
id | string | No | — |
provider | string | Yes | — |
status | string<not_connected, unverified, verified, rejected> | Yes | — |
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… |
Errors this endpoint can return
401 · 403 · 422