Skip to main content

Set the global announcement banner

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

PATCH/enterprise/announcement
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Body Params
required
application/jsonEnterprise Announcement object
announcement announcement-message string
required

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."

Example: Very **important** announcement about _nothing_.

expires_at announcement-expiration string<date-time>
optionalnullable

The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/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: "2021-01-01T00:00:00.000-07:00"

Responses

application/json Enterprise Announcement object

Response

announcement announcement-message string
required

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/[email protected]/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."

Example: Very **important** announcement about _nothing_.

expires_at announcement-expiration string<date-time>
optionalnullable

The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/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: "2021-01-01T00:00:00.000-07:00"