REST /api/v1/notification-announcements 5 endpoints
GET /api/v1/notification-announcements/api/v1/notification-announcements

List recent accessibility announcements issued for a user

Public

Response Example

{
  "data": [
    {
      "id": "ann_001",
      "user_id": "user_xyz789",
      "announcement_type": "new_notification",
      "message": "New notification: Alex mentioned you in a check-in",
      "issued_at": "2026-03-26T09:15:05Z"
    },
    {
      "id": "ann_002",
      "user_id": "user_xyz789",
      "announcement_type": "unread_count_change",
      "message": "You have 12 unread notifications",
      "issued_at": "2026-03-26T09:15:10Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2
  }
}
GET /api/v1/notification-announcements/api/v1/notification-announcements/:id

Get details of a specific accessibility announcement

Public

Response Example

{
  "id": "ann_001",
  "user_id": "user_xyz789",
  "announcement_type": "new_notification",
  "message": "New notification: Alex mentioned you in a check-in",
  "notification_id": "notif_a1b2c3",
  "issued_at": "2026-03-26T09:15:05Z"
}
POST /api/v1/notification-announcements/api/v1/notification-announcements

Issue an accessibility announcement (new notification, count change, etc.)

Public

Request Example

{
  "user_id": "user_xyz789",
  "announcement_type": "mark_read_confirmation",
  "notification_id": "notif_a1b2c3",
  "marked_count": 1
}

Response Example

{
  "id": "ann_003",
  "user_id": "user_xyz789",
  "announcement_type": "mark_read_confirmation",
  "message": "1 notification marked as read",
  "notification_id": "notif_a1b2c3",
  "marked_count": 1,
  "issued_at": "2026-03-26T09:45:30Z"
}
PUT /api/v1/notification-announcements/api/v1/notification-announcements/:id

Update an announcement record (e.g. mark as acknowledged by assistive tech)

Public

Request Example

{
  "acknowledged": true,
  "acknowledged_at": "2026-03-26T09:45:35Z"
}

Response Example

{
  "id": "ann_003",
  "user_id": "user_xyz789",
  "announcement_type": "mark_read_confirmation",
  "message": "1 notification marked as read",
  "acknowledged": true,
  "acknowledged_at": "2026-03-26T09:45:35Z",
  "issued_at": "2026-03-26T09:45:30Z"
}
DELETE /api/v1/notification-announcements/api/v1/notification-announcements/:id

Delete an accessibility announcement record

Public

Response Example

{
  "success": true,
  "deleted_id": "ann_003"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}