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 tokens for "Get the global announcement banner"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
HTTP response status codes for "Get the global announcement banner"
| Status code | Description |
|---|---|
200 | OK |
Code samples for "Get the global announcement banner"
Request example
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/announcementAnnouncement 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 tokens for "Set the global announcement banner"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.