Bannières d’annonce de l’organisation
L’API Bannières d’annonce de l’organisation vous permet d’obtenir, de définir et de supprimer la bannière d’annonce pour votre organisation.
Get announcement banner for organization
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.
Paramètres pour « Get announcement banner for organization »
| En-têtes |
|---|
| Nom, Type, Description |
accept string Setting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
org string ObligatoireThe organization name. The name is not case sensitive. |
Codes d’état de la réponse HTTP pour « Get announcement banner for organization »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Get announcement banner for organization »
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/announcementAnnouncement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Set announcement banner for organization
Sets the announcement banner to display for the organization.
Paramètres pour « Set announcement banner for organization »
| En-têtes |
|---|
| Nom, Type, Description |
accept string Setting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
org string ObligatoireThe organization name. The name is not case sensitive. |
| Paramètres du corps |
| Nom, Type, Description |
announcement string or null ObligatoireThe 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: |
Codes d’état de la réponse HTTP pour « Set announcement banner for organization »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Set announcement banner for organization »
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
}Remove announcement banner from organization
Removes the announcement banner currently set for the organization.
Paramètres pour « Remove announcement banner from organization »
| En-têtes |
|---|
| Nom, Type, Description |
accept string Setting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
org string ObligatoireThe organization name. The name is not case sensitive. |
Codes d’état de la réponse HTTP pour « Remove announcement banner from organization »
| Code d’état | Description |
|---|---|
204 | No Content |
Exemples de code pour « Remove announcement banner from organization »
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/announcementResponse
Status: 204