enterprise-admin

Set the global announcement banner

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

patch/enterprise/announcement

Request

  • Base URL: http://HOSTNAME/api/v3
  • URL: http://HOSTNAME/api/v3/enterprise/announcement
  • Auth: none declared

Request body

announcementstring nullable required

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."

expires_atstring date-time nullable

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.

Example request

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "\"2021-01-01T00:00:00.000-07:00\""
}

Response

Response

announcementstring nullable required

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."

expires_atstring date-time nullable

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.

Example response

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "\"2021-01-01T00:00:00.000-07:00\""
}

Changes

No recorded changes to this operation across all 50 revisions of this API.