Types

Banner

A banner: a notice shown to the users of an organisation inside a display window.

idrequired
integer
The banner id. Banners keep the integer ids they have always had.
titlerequired
string | null
The headline, up to 256 characters.
descriptionrequired
string | null
The body of the banner, as HTML. It is stored and shown as sent, without sanitising.
typerequired
string
How a reader can respond: `dismissible` can be closed, `confirmable` must be confirmed, `always_shown` cannot be closed.One of: dismissible, confirmable, always_shown
display_fromrequired
string | null (date-time)
When the banner starts to show.
display_untilrequired
string | null (date-time)
When the banner stops showing.
background_colourrequired
string | null
The background colour as #rrggbb, or null for the platform default.
text_colourrequired
string | null
The text colour as #rrggbb, or null for the platform default.
expandedrequired
boolean
Whether the banner opens expanded.
role_idsrequired
integer[]
The roles the banner is for, in ascending order. Empty means every user of the organisation.
created_atrequired
string (date-time)
When the banner was created.
updated_atrequired
string | null (date-time)
When the banner or its roles last changed.

Used by (4)