Atlassian: Announcement banner schemas

← Announcement banner operations · All schemas

Get announcement banner configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	Announcement banner configuration.
hashId	JSON	Optional
hashId (anyOf 1)	string	Alternative	Hash of the banner data. The client detects updates by comparing hash IDs. Read only: true
hashId (anyOf 2)	null	Alternative
isDismissible	JSON	Optional
isDismissible (anyOf 1)	boolean	Alternative	Flag indicating if the announcement banner can be dismissed by the user. Read only: true
isDismissible (anyOf 2)	null	Alternative
isEnabled	JSON	Optional
isEnabled (anyOf 1)	boolean	Alternative	Flag indicating if the announcement banner is enabled or not. Read only: true
isEnabled (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative	The text on the announcement banner. Read only: true
message (anyOf 2)	null	Alternative
visibility	JSON	Optional
visibility (anyOf 1)	string	Alternative	Visibility of the announcement banner. Known values: public, private Read only: true
visibility (anyOf 2)	null	Alternative

Update announcement banner configuration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Configuration of the announcement banner. write Only: true Additional keys: not allowed
isDismissible	boolean	Optional	Flag indicating if the announcement banner can be dismissed by the user.
isEnabled	boolean	Optional	Flag indicating if the announcement banner is enabled or not.
message	string	Optional	The text on the announcement banner.
visibility	string	Optional	Visibility of the announcement banner. Can be public or private.