API Docs / Schemas / CurrentAnnouncementDto

CurrentAnnouncementDto

The currently active platform announcement banner, as shown to all users in the web app.

Properties

Name Type Description
codestring

Unique code identifying the announcement. Used as the per-browser dismissal key.

Unique code identifying the announcement. Used as the per-browser dismissal key.

messagestring

The banner text shown on large screens.

The banner text shown on large screens.

messageShortstring

Shorter banner text shown on small screens. Falls back to Message when null.

Shorter banner text shown on small screens. Falls back to Message when null.

textColorstring

Hex colour for the banner text (e.g. "#FFFFFF").

Hex colour for the banner text (e.g. "#FFFFFF").

backgroundColorstring

Hex colour for the banner background (e.g. "#000000").

Hex colour for the banner background (e.g. "#000000").

linkUrlstring

Optional link rendered after the message. Null means no link.

Optional link rendered after the message. Null means no link.

linkTextstring

Text for the optional link. Falls back to "Find out more" when null.

Text for the optional link. Falls back to "Find out more" when null.

JSON Example

{
  "code": "string",
  "message": "string",
  "messageShort": "string",
  "textColor": "string",
  "backgroundColor": "string"
}

Used By Operations