Campaigns
POST /v1/campaigns/esp
Connect an e-mail provider account.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка узима org_id као поље у JSON телу.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
api_key | string | Да | — |
from_local_part | string | Не | — |
from_display_name | string | Не | — |
sending_domain | string | Не | — |
reply_to | string | Не | — |
org_id | string | Не | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
connected | boolean | Да | — |
id | string | Не | — |
provider | string | Да | — |
status | string<not_connected, unverified, verified, rejected> | Да | — |
from_address | string | Не | — |
from_local_part | string | Не | — |
from_display_name | string | Не | — |
sending_domain | string | Не | — |
reply_to | string | Не | — |
verified_domains | EspVerifiedDomain[] | Не | — |
last_verified_at | string | Не | — |
last_error | string | Не | — |
stats | CampaignDeliveryCounts | Не | ⛔ 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… |
Грешке које ова крајња тачка може вратити
401 · 403 · 422 · 503