---
title: "Update the banner"
method: PUT
path: "/customization/banner"
tags: ["Customization"]
---

# Update the banner

`PUT /customization/banner`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/customization/banner`
- Auth: none declared

Updates the banner.

## Request body

- IapBannerSchema: The root schema comprises the entire JSON document.
  - `_id` string: String representation of a MongoDB ObjectId
  - `active` boolean, required: A flag indicating if the banner will be displayed to users
  - `text` string, required: Text in the banner when displayed
  - `backgroundColor` string: The background color for the banner displayed
  - `dismissible` boolean, required: A flag indicating if a banner should be dismissible by users
  - `startTime` string, required: An ISO Timestring value indicating when the banner will show
  - `endTime` string: A, ISO Timestring value indicating when the banner will no longer show
  - `allPages` boolean, required: A flag indicating if the banner should show on all pages or only the IAP home page
  - `image` string: A base64 image string containing the image that will be shown on the banner
  - `messageLastUpdated` string: An ISO Timestring value indicating when the banner message was last updated

## Response `200`

The result from the database

- CustomizationUpdateBannerResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)