Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations
Announcement Banner

UpdateAnnouncementBanner

organizations.announcement_banner.update(AnnouncementBannerUpdateParams**kwargs) -> AnnouncementBannerUpdateResponse
POST/gitpod.v1.OrganizationService/UpdateAnnouncementBanner

Updates the announcement banner configuration for an organization.

Use this method to configure the announcement banner displayed to all users. Only organization admins can update the banner. Requires Enterprise tier.

Examples

  • Enable announcement banner:

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
message: "Scheduled maintenance on Saturday 10pm-2am UTC"
enabled: true

  • Disable announcement banner:

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
enabled: false
ParametersExpand Collapse
organization_id: str

organization_id is the ID of the organization

formatuuid
enabled: Optional[bool]

enabled controls whether the banner is displayed

message: Optional[str]

message is the banner message. Supports basic Markdown. Maximum 1000 characters.

maxLength1000
ReturnsExpand Collapse
class AnnouncementBannerUpdateResponse: …

UpdateAnnouncementBanner

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
announcement_banner = client.organizations.announcement_banner.update(
    organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
    enabled=False,
)
print(announcement_banner.banner)
{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}
Returns Examples
{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}