告知

この REST API を使い、企業の世界向け告知バナーを管理します。

告知について

この REST API を使い、企業の世界向け広告バナーを管理できます。詳しくは、「Enterprise のユーザメッセージをカスタマイズする」を参照してください。

Gets the current message and expiration date of the global announcement banner in your enterprise.

状態コード	説明
`200`	OK

get/enterprise/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprise/announcement

Announcement banner

Status: 200

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

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

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
本文のパラメーター
名前, Type, 説明
`announcement` string or null 必須 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.

状態コード	説明
`200`	OK

patch/enterprise/announcement

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://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
}

Removes the global announcement banner in your enterprise.

状態コード	説明
`204`	No Content

delete/enterprise/announcement

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204

告知

告知について

Get the global announcement banner

"Get the global announcement banner" の HTTP 応答状態コード

"Get the global announcement banner" のコードサンプル

Set the global announcement banner

"Set the global announcement banner" のパラメーター

"Set the global announcement banner" の HTTP 応答状態コード

"Set the global announcement banner" のコードサンプル

Remove the global announcement banner

"Remove the global announcement banner" の HTTP 応答状態コード

"Remove the global announcement banner" のコードサンプル