Update notification banner

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Put
/api/v1/orgs/{orgId}/banner/{bannerId}
Security
HTTP
Type bearer
Path parameters
orgId
stringRequired

The Org orgId

bannerId
stringRequired

The banner Id

Body parameters

The details for the notification banner

Expand All
object
allowDismiss
boolean
bannerType
string
enabled
boolean
message
string
schedule
object
fromDate
string
toDate
string
Responses
200

OK

Expand All
object
authorization
boolean
data
Array of object (NotificationBanner)
object
allowDismiss
boolean
bannerType
string
created_by
string
enabled
boolean
id
string
message
string
schedule
object
fromDate
string
timezone
string
toDate
string
whenChanged
string
whenCreated
string
error_code
integer
error_message
string
error_status
boolean
Examplefalse
401

Unauthorized

object
error_code
integer
error_message
string
error_status
boolean
422

Unprocessable Entity

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean