notifications

PUT `/v1/sites/{site_id}/notification-channels`

Replace this site's notification channels.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X PUT https://api.zinndigital.com/v1/sites/{site_id}/notification-channels \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "channels": <SiteNotificationChannel[]> }'

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

The COMPLETE desired routing, sent as one document. A channel absent from the list is one the customer removed - a POST-only surface could not express removal, and the screen is a matrix the customer edits in several places before pressing save once. Refused 422 when email_muted is true and no listed destination is a non-e-mail channel that is verified and delivering. The check runs against the routing you are ABOUT to save, not the current one, so "connect Slack and turn e-mail off" works in a single request. It is refused at the point of asking rather than accepted and ignored: a toggle that accepts a value it will not honour reads as a broken setting.

Параметри

Назив	Тип	Обавезно	Шта је ово
`site_id (path)`	`string`	Да	—
`org_id (query)`	`string`	Не	The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it. A reseller managing a client…

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`channels`	`SiteNotificationChannel[]`	Да	The COMPLETE set. Anything absent is removed.
`email_muted`	`boolean`	Не	Ask for e-mail to be switched off. Refused `422` unless at least one listed destination is a non-e-mail channel that is verified and delivering.

Одговор

Назив	Тип	Обавезно	Шта је ово
`site_id`	`string`	Да	—
`channels`	`SiteNotificationChannel[]`	Да	—
`email_muted`	`boolean`	Да	What the customer ASKED for. Not necessarily what is happening.
`email_active`	`boolean`	Да	Whether e-mail is actually being sent right now. Computed at send time from the live health of the other channels, never read from a stored flag.
`email_reason`	`string<not_muted, muted, alternatives_failing, no_alternative, unreadable>`	Да	Why. `not_muted` - the customer never turned it off. `muted` - off, as asked, with a healthy alternative. `alternatives_failing` - back ON because their other channels have…
`healthy_alternatives`	`integer`	Не	How many non-e-mail destinations this site routes to are delivering.
`overriding_choice`	`boolean`	Не	True when e-mail is being sent DESPITE the customer having muted it. This is the state a screen must explain, or the toggle appears broken.

Грешке које ова крајња тачка може вратити

422

PUT /v1/sites/{site_id}/notification-channels