Sign in
Super Admin Platform Config

Set the app-wide alert banner

Enable or disable the persistent alert banner shown to all users and set its message. When enabling, a non-empty message is required. Super admin only.

put/super-admin/platform-config/app-alert

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

enabledboolean required

Whether to show the app-wide alert banner

messagestring required

The alert banner text. Required (non-empty) when enabled is true.

Example request

{
  "enabled": true,
  "message": "The system is currently experiencing degraded performance."
}

Response

Successfully updated the app alert banner

Changes

No recorded changes to this operation across all 50 revisions of this API.