notices
GET /v1/notices
The notices to show at the top of this screen.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X GET https://api.zinndigital.com/v1/notices \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
docs/87. What the platform is currently telling this customer, on this route, in their language — already sanitised, already localised. ⛔ No permission key. Reading the notices aimed at you is not a privilege: gating it would mean a member whose role happens to lack org.read never learns their card needs re-adding. The audience is the scope — a notice reaches an organization only if it is explicitly everyone or that org is named in its audience. An untargeted notice reaches nobody, never everybody. Exactly one of body_html and body_i18n_key is populated (a database constraint). body_html is operator-authored and safe to render as HTML; body_i18n_key + body_params are rendered from the SPA's own catalogue.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
route (query) | string | नहीं | The dashboard path being rendered, e.g. /billing/invoices. Defaults to /. A query string is ignored, so a notice aimed at /billing does not vanish when the screen adds a tab. |
org_id (query) | string | नहीं | Narrow to one organization. Omitted, the caller's whole accessible subtree is considered, so a reseller admin sees a notice aimed at a client org they manage. An id outside that… |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
data | Notice[] | हाँ | — |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 429