v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB

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

post/gitpod.v1.OrganizationService/UpdateAnnouncementBanner

Request body

enabledboolean nullable

enabled controls whether the banner is displayed

messagestring nullable

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

organizationIdstring uuid required

organization_id is the ID of the organization

Response

Success