Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

Announcement Banner

GetAnnouncementBanner
client.organizations.announcementBanner.get(AnnouncementBannerGetParams { organizationId } body, RequestOptionsoptions?): AnnouncementBannerGetResponse { banner }
POST/gitpod.v1.OrganizationService/GetAnnouncementBanner
UpdateAnnouncementBanner
client.organizations.announcementBanner.update(AnnouncementBannerUpdateParams { organizationId, enabled, message } body, RequestOptionsoptions?): AnnouncementBannerUpdateResponse { banner }
POST/gitpod.v1.OrganizationService/UpdateAnnouncementBanner
ModelsExpand Collapse
AnnouncementBanner { organizationId, enabled, message }
organizationId: string

organization_id is the ID of the organization

formatuuid
enabled?: boolean

enabled controls whether the banner is displayed

message?: string

message is the banner message displayed to users. Supports basic Markdown.

maxLength1000
AnnouncementBannerGetResponse { banner }
AnnouncementBannerUpdateResponse { banner }