notifications
GET /v1/notification-preferences
What you want to hear about, by topic.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/notification-preferences \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Every topic you receive mail on, with your current answer and whether it can be changed at all. A topic you may NOT silence is still returned, with `can_opt_out: false` and a `reason` naming the duty. Dropping it would be a screen that lies by omission: you would conclude we do not email about security, switch off everything visible, and be surprised by a suspension notice. A topic nobody receives anything on is omitted entirely - offering a switch for mail that does not exist invites you to turn it off and conclude the screen is broken.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | string | Не | The organization to act on. Omitted (or empty) means your own. A reseller managing a client org must name it - defaulting silently would write the reseller's own preferences whi… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
data | NotificationPreference[] | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 429