Types

BannerUpdate

The body that changes a banner. Send only the fields you change.

title
string
The headline. Cannot be empty or null.
description
string | null
The body of the banner, as HTML. Stored as sent.
type
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_from
string (date-time)
When the banner starts to show. Cannot be null.
display_until
string (date-time)
When the banner stops showing. On or after display_from, also the stored one. Cannot be null.
background_colour
string | null
The background colour as #rrggbb; null goes back to the platform default.
text_colour
string | null
The text colour as #rrggbb; null goes back to the platform default.
expanded
boolean
Whether the banner opens expanded.
role_ids
integer[]
Every role of your organisation the banner should be for, replacing the current set. An empty list makes it for every user.

Used by (1)