UpdateAnnouncementBanner

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

Body ParametersJSONExpand Collapse

organizationId: string

organization_id is the ID of the organization

formatuuid

enabled: optional boolean

enabled controls whether the banner is displayed

message: optional string

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

maxLength1000

ReturnsExpand Collapse

message: optional string

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

maxLength1000

UpdateAnnouncementBanner

curl https://app.gitpod.io/api/gitpod.v1.OrganizationService/UpdateAnnouncementBanner \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{
          "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
        }'

{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}

Returns Examples

{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}