Banner mit Ankündigungen der Organisation

Mithilfe der API für Banner mit Organisationsankündigungen kannst du das Ankündigungsbanner für deine Organisation abrufen, festlegen und entfernen.

Funktioniert mit GitHub Apps

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Statuscode	BESCHREIBUNG
`200`	OK

get/orgs/{org}/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/announcement

Announcement banner

Status: 200

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00",
  "user_dismissible": false
}

Funktioniert mit GitHub Apps

Sets the announcement banner to display for the organization.

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
`announcement` string or null Erforderlich The 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: `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.

Statuscode	BESCHREIBUNG
`200`	OK

patch/orgs/{org}/announcement

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/announcement \
  -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'

Announcement banner

Status: 200

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00",
  "user_dismissible": false
}

Funktioniert mit GitHub Apps

Removes the announcement banner currently set for the organization.

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Statuscode	BESCHREIBUNG
`204`	No Content

delete/orgs/{org}/announcement

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/announcement

Response

Status: 204

Banner mit Ankündigungen der Organisation

Get announcement banner for organization

Parameter für „Get announcement banner for organization“

HTTP-Antwortstatuscodes für „Get announcement banner for organization“

Codebeispiele für „Get announcement banner for organization“

Announcement banner

Set announcement banner for organization

Parameter für „Set announcement banner for organization“

HTTP-Antwortstatuscodes für „Set announcement banner for organization“

Codebeispiele für „Set announcement banner for organization“

Announcement banner

Remove announcement banner from organization

Parameter für „Remove announcement banner from organization“

HTTP-Antwortstatuscodes für „Remove announcement banner from organization“

Codebeispiele für „Remove announcement banner from organization“

Response