Update the banner

Updates the banner.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

updates
activebooleanRequired
A flag indicating if the banner will be displayed to users
textstringRequired
Text in the banner when displayed
dismissiblebooleanRequired
A flag indicating if a banner should be dismissible by users
startTimestringRequiredformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
An ISO Timestring value indicating when the banner will show
allPagesbooleanRequired
A flag indicating if the banner should show on all pages or only the IAP home page
_idstringOptionalformat: "^[0-9a-f]{24}$"
String representation of a MongoDB ObjectId
backgroundColorstringOptional
The background color for the banner displayed
endTimestringOptionalformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
A, ISO Timestring value indicating when the banner will no longer show
imagestringOptional
A base64 image string containing the image that will be shown on the banner
messageLastUpdatedstringOptionalformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
An ISO Timestring value indicating when the banner message was last updated

Response

The result from the database
statusenum
The status of the API request.
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.

Errors

500
Internal Server Error