orgs

Set announcement banner for organization

Sets the announcement banner to display for the organization.

patch/orgs/{org}/announcement

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/announcement
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

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.

user_dismissibleboolean nullable

Whether an announcement can be dismissed by the user.

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 required

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_dismissibleboolean nullable required

Whether an announcement can be dismissed by the user.

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 83 revisions of this API.