notifications

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

Replace this site's notification channels.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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[]> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`site_id (path)`	`string`	Evet	—
`org_id (query)`	`string`	Hayır	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…

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`channels`	`SiteNotificationChannel[]`	Evet	The COMPLETE set. Anything absent is removed.
`email_muted`	`boolean`	Hayır	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.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`site_id`	`string`	Evet	—
`channels`	`SiteNotificationChannel[]`	Evet	—
`email_muted`	`boolean`	Evet	What the customer ASKED for. Not necessarily what is happening.
`email_active`	`boolean`	Evet	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>`	Evet	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`	Hayır	How many non-e-mail destinations this site routes to are delivering.
`overriding_choice`	`boolean`	Hayır	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.

Bu uç noktanın dönderebileceği hatalar

422