REST API endpoints for global announcements

About announcements

You can use the REST API to manage the global announcement banner in your enterprise. For more information, see Customizing user messages for your enterprise.

Note

These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

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	Description
`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: 2022-11-28" \
  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.

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`announcement` string or null Required 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.

Status code	Description
`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: 2022-11-28" \
  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	Description
`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: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204

REST API endpoints for global announcements

About announcements

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"

Parameters for "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