Sign in

v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Banners

Enables a banner.

Enterprise feature

Enables an existing banner, identified by its id.

post/api/admin/banners/{id}/on

Path parameters

idstring required

Response

bannerSchema

idinteger required

The banner's ID. Banner IDs are incrementing integers. In other words, a more recently created banner will always have a higher ID than an older one.

messagestring required

The message to display to all users. Supports markdown.

enabledboolean

Whether the banner should be displayed currently. If not specified, defaults to true.

variantstring

The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".

stickyboolean

Whether the banner should be sticky on the screen. If not specified, defaults to false.

iconstring nullable

The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If "none", no icon will be displayed.

linkstring nullable

The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: "https://example.com" or relative: "/admin/service-accounts"). If "dialog", will display a dialog when clicked. If not specified, no link will be displayed.

linkTextstring nullable

The text to display on the link. If not specified, will be displayed as "More info".

dialogTitlestring nullable

The title to display on the dialog. If not specified, this will be the same as linkText.

dialogstring nullable

The markdown to display on the dialog. If not specified, no dialog will be displayed.

createdAtstring date-time required

The date and time of when the banner was created.

Example response

{
  "id": 7,
  "message": "**Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.",
  "enabled": true,
  "variant": "info",
  "sticky": true,
  "icon": "build",
  "link": "dialog",
  "linkText": "Learn more",
  "dialogTitle": "Learn more about it here",
  "dialog": "# Information\n\nMaintenance is **scheduled**.\n\n## More details\n\nThis is an example dialog that supports Markdown.",
  "createdAt": "2023-12-27T13:37:00+01:00"
}