Campaigns

POST /v1/campaigns/esp/verify

Prove the provider account works and read its verified domains.

Lahat ng Campaigns endpoint

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Kung saan mapupunta ang id ng iyong organisasyon

Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X POST https://api.zinndigital.com/v1/campaigns/esp/verify \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Katawan ng kahilingan

PangalanUriKailanganAno ito
org_idstringHindi

Tugon

PangalanUriKailanganAno ito
connectedbooleanOo
idstringHindi
providerstringOo
statusstring<not_connected, unverified, verified, rejected>Oo
from_addressstringHindi
from_local_partstringHindi
from_display_namestringHindi
sending_domainstringHindi
reply_tostringHindi
verified_domainsEspVerifiedDomain[]Hindi
last_verified_atstringHindi
last_errorstringHindi
statsCampaignDeliveryCountsHindi⛔ `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…

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422