Skip to main content

Enables a banner.

POST 

<your-unleash-url>/api/admin/banners/:id/on

Enables an existing banner, identified by its id.

Request

Path Parameters

    id stringrequired

Responses

bannerSchema

Schema
    idintegerrequired

    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.

    Possible values: >= 1

    Example: 7
    messagestringrequired

    The message to display to all users. Supports markdown.

    Example: **Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.
    enabledboolean

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

    Example: true
    variantstring

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

    Example: info
    stickyboolean

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

    Example: true
    iconstringnullable

    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.

    Example: build
    linkstringnullable

    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.

    Example: dialog
    linkTextstringnullable

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

    Example: Learn more
    dialogTitlestringnullable

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

    Example: Learn more about it here
    dialogstringnullable

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

    Example: # Information Maintenance is **scheduled**. ## More details This is an example dialog that supports Markdown.
    createdAtdate-timerequired

    The date and time of when the banner was created.

    Example: 2023-12-27T13:37:00+01:00

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L -X POST '<your-unleash-url>/api/admin/banners/:id/on' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!