Customization

Update the banner

Updates the banner.

put/customization/banner

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/customization/banner
  • Auth: none declared

Request body

_idstring

String representation of a MongoDB ObjectId

activeboolean required

A flag indicating if the banner will be displayed to users

textstring required

Text in the banner when displayed

backgroundColorstring

The background color for the banner displayed

dismissibleboolean required

A flag indicating if a banner should be dismissible by users

startTimestring required

An ISO Timestring value indicating when the banner will show

endTimestring

A, ISO Timestring value indicating when the banner will no longer show

allPagesboolean required

A flag indicating if the banner should show on all pages or only the IAP home page

imagestring

A base64 image string containing the image that will be shown on the banner

messageLastUpdatedstring

An ISO Timestring value indicating when the banner message was last updated

Response

The result from the database

status'OK' | 'Created'

The status of the API request.

messagestring

Message containing either confirmation of the operation or the reason for the failure of the operation.

Changes

No recorded changes to this operation across all 1 revision of this API.