notifications

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

Replace this site's notification channels.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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