Update a banner.

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

Updates an existing banner identified by its id.

Request

Responses

200

bannerSchema

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.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/banners/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "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."
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

id — pathrequired

Body required

{
  "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."
}

ResponseClear

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