The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for global announcements

Use the REST API to manage the global announcement banner in your enterprise.

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.

Get the global announcement banner

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

fine_grained_access

no_fine_grained_access

http_status_code

status_codeDescription
200

OK

code_samples

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 }

Set the global announcement banner

Sets the message and expiration time for the global announcement banner in your enterprise.

fine_grained_access

no_fine_grained_access

Parameters for "Set the global announcement banner"

Headers
accept string

Setting to application/vnd.github+json is recommended.

Body parameters
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.

user_dismissible boolean or null

Whether an announcement can be dismissed by the user.

Default: false

http_status_code

status_codeDescription
200

OK

code_samples

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 }

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

fine_grained_access

no_fine_grained_access

http_status_code

status_codeDescription
204

No Content

code_samples

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