Announcements
Platform-wide announcements with live streaming
Announcements are short notices the platform broadcasts to organization admins. The stream endpoint pushes new entries over server-sent events.
Resource overview
GET
/api/announcementsAPI key · SessionPOST
/api/announcementsSessionRole: Super AdminGET
/api/announcements/streamAPI key · SessionPOST
/api/announcements/{id}/readAPI key · SessionPATCH
/api/announcements/{id}SessionRole: Super AdminDELETE
/api/announcements/{id}SessionRole: Super AdminList announcements
GET
/api/announcementsAPI key · SessionReturns the active announcements visible to the caller, with each one's
readAt for the current user.
Live stream
GET
/api/announcements/streamAPI key · SessionServer-Sent Events. Connect with Accept: text/event-stream; the connection
emits one data: { ... } line per new or updated announcement.
Mark as read
POST
/api/announcements/{id}/readAPI key · Session200
{ "success": true, "readAt": "2026-05-20T10:14:00Z" }Publish / update / delete (super admin)
POST
/api/announcementsSessionRole: Super AdminPATCH
/api/announcements/{id}SessionRole: Super AdminDELETE
/api/announcements/{id}SessionRole: Super Admin| Name | Type | Required | Description |
|---|---|---|---|
title | string | Required | Headline (3–120 chars). |
body | string | Required | Message body (1–2000 chars). |
level | string | Optional | `info`, `warning`, or `critical`. Default: info |
expiresAt | string (ISO 8601) | Optional | Auto-hide after this date. |