REST-API-Endpunkte für globale Ankündigungen

Verwende die REST-API, um das globale Ankündigungsbanner in deinem Unternehmen zu verwalten.

Informationen zu Ankündigungen

Du kannst die REST-API verwenden, um das globale Ankündigungsbanner in deinem Unternehmen zu verwalten. Weitere Informationen finden Sie unter Anpassen von Benutzernachrichten für dein Unternehmen.

Hinweis

Diese Endpunkte unterstützen nur die Authentifizierung über ein personal access token (classic). Weitere Informationen finden Sie unter Verwalten deiner persönlichen Zugriffstoken.

Gets the current message and expiration date of the global announcement banner in your enterprise.

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Status code	BESCHREIBUNG
`200`	OK

Request example

get/enterprise/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/enterprise/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 message and expiration time for the global announcement banner in your enterprise.

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

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

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/enterprise/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/enterprise/announcement \
  -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00"}'

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 global announcement banner in your enterprise.

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Status code	BESCHREIBUNG
`204`	No Content

Request example

delete/enterprise/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/enterprise/announcement

Response

Status: 204

REST-API-Endpunkte für globale Ankündigungen

Informationen zu Ankündigungen

Get the global announcement banner

Fine-grained access tokens for "Get the global announcement banner"

HTTP response status codes for "Get the global announcement banner"

Code samples for "Get the global announcement banner"

Request example

Announcement banner

Set the global announcement banner

Fine-grained access tokens for "Set the global announcement banner"

Parameter für "Set the global announcement banner"

HTTP response status codes for "Set the global announcement banner"

Code samples for "Set the global announcement banner"

Request example

Announcement banner

Remove the global announcement banner

Fine-grained access tokens for "Remove the global announcement banner"

HTTP response status codes for "Remove the global announcement banner"

Code samples for "Remove the global announcement banner"

Request example

Response