REST-API-Endpunkte für Banner mit Organisationsankündigungen

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Organization announcement banners" organization permissions (read)

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Status code	BESCHREIBUNG
`200`	OK

Request example

get/orgs/{org}/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/announcement

Announcement banner

Status: 200

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00",
  "user_dismissible": false
}

Sets the announcement banner to display for the organization.

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Organization announcement banners" organization permissions (write)

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Körperparameter
Name, Typ, BESCHREIBUNG
`announcement` string or null Erforderlich The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."
`expires_at` string or null The time at which the announcement expires. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.
`user_dismissible` boolean or null Whether an announcement can be dismissed by the user. Standard: `false`

Status code	BESCHREIBUNG
`200`	OK

Request example

patch/orgs/{org}/announcement

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/announcement \
  -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'

Announcement banner

Status: 200

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00",
  "user_dismissible": false
}

Removes the announcement banner currently set for the organization.

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Organization announcement banners" organization permissions (write)

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Status code	BESCHREIBUNG
`204`	No Content

Request example

delete/orgs/{org}/announcement

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/announcement

Response

Status: 204

REST-API-Endpunkte für Banner mit Organisationsankündigungen

Get announcement banner for organization

Fine-grained access tokens for "Get announcement banner for organization"

Parameter für "Get announcement banner for organization"

HTTP response status codes for "Get announcement banner for organization"

Code samples for "Get announcement banner for organization"

Request example

Announcement banner

Set announcement banner for organization

Fine-grained access tokens for "Set announcement banner for organization"

Parameter für "Set announcement banner for organization"

HTTP response status codes for "Set announcement banner for organization"

Code samples for "Set announcement banner for organization"

Request example

Announcement banner

Remove announcement banner from organization

Fine-grained access tokens for "Remove announcement banner from organization"

Parameter für "Remove announcement banner from organization"

HTTP response status codes for "Remove announcement banner from organization"

Code samples for "Remove announcement banner from organization"

Request example

Response