Types

BannerCreate

The body that creates a banner.

titlerequired
string
The headline.
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_shownDefault: "dismissible"
display_fromrequired
string (date-time)
When the banner starts to show.
display_untilrequired
string (date-time)
When the banner stops showing. On or after display_from.
background_colour
string | null
The background colour as #rrggbb.
text_colour
string | null
The text colour as #rrggbb.
expanded
boolean
Whether the banner opens expanded.Default: false
role_ids
integer[]
The roles of your organisation the banner is for. Omit or send an empty list for every user. An id that is not a role of your organisation returns 422 `exists`.

Used by (1)