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."
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: 2022-11-28" \
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.
Parameters for "Set the global announcement banner"
| Name, Type, Description |
|---|
accept string Setting to |
| Name, Type, Description |
|---|
announcement string or null RequiredThe 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: |
HTTP response status codes for "Set the global announcement banner"
| Status code | Description |
|---|---|
200 | OK |
Code samples for "Set the global announcement banner"
Request example
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 tokens for "Remove 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 "Remove the global announcement banner"
| Status code | Description |
|---|---|
204 | No Content |
Code samples for "Remove the global announcement banner"
Request example
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/announcementResponse
Status: 204