---
title: "Update a banner."
method: PUT
path: "/api/admin/banners/{id}"
tags: ["Banners"]
---

# Update a banner.

`PUT /api/admin/banners/{id}`

**Enterprise feature**

Updates an existing banner identified by its id.

## Path parameters

- `id` string, required

## Request body

- CreateBannerSchema — Describes the properties required to create or update a banner.
  - `message` string, required — The message to display to all users. Supports markdown.
  - `enabled` boolean — Whether the banner should be displayed currently. If not specified, defaults to true.
  - `variant` string — The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
  - `sticky` boolean — Whether the banner should be sticky on the screen. If not specified, defaults to `false`.
  - `icon` string, 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.
  - `link` string, 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.
  - `linkText` string, nullable — The text to display on the link. If not specified, will be displayed as "More info".
  - `dialogTitle` string, nullable — The title to display on the dialog. If not specified, this will be the same as `linkText`.
  - `dialog` string, nullable — The markdown to display on the dialog. If not specified, no dialog will be displayed.

## Response `200`

bannerSchema

- BannerSchema — An object describing a banner to be displayed to all users.
  - `id` integer, 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.
  - `message` string, required — The message to display to all users. Supports markdown.
  - `enabled` boolean — Whether the banner should be displayed currently. If not specified, defaults to true.
  - `variant` string — The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
  - `sticky` boolean — Whether the banner should be sticky on the screen. If not specified, defaults to `false`.
  - `icon` string, 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.
  - `link` string, 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.
  - `linkText` string, nullable — The text to display on the link. If not specified, will be displayed as "More info".
  - `dialogTitle` string, nullable — The title to display on the dialog. If not specified, this will be the same as `linkText`.
  - `dialog` string, nullable — The markdown to display on the dialog. If not specified, no dialog will be displayed.
  - `createdAt` string, date-time, required — The date and time of when the banner was created.

## Other responses

- `400` — The request data does not match what we expect.
- `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
- `403` — The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- `404` — The requested resource was not found.
- `415` — The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/revisions/b2c3116e633e/schema)