notifications

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

Replace this site's notification channels.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د پوښتنې پیرامیتر په توګه 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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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