Announcement banner

Update announcement banner configuration

Updates the announcement banner configuration.

Permissions required: Administer Jira global permission.

put/rest/api/2/announcementBanner

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/announcementBanner
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Request body

isDismissibleboolean

Flag indicating if the announcement banner can be dismissed by the user.

isEnabledboolean

Flag indicating if the announcement banner is enabled or not.

messagestring

The text on the announcement banner.

visibilitystring

Visibility of the announcement banner. Can be public or private.

Response

Returned if the request is successful.

unknown required

Changes

No recorded changes to this operation across all 26 revisions of this API.