Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | Uuid | Не | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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… |
Грешки, които този крайpoint може да върне
401 · 403