Banners de anuncios de empresa
La API de banners de anuncios de empresa te permite obtener, establecer y quitar el banner del anuncio de tu empresa.
Get announcement banner for enterprise
Gets the announcement banner currently set for the enterprise.
Parámetros para "Get announcement banner for enterprise"
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
accept string Setting to |
| Parámetros de la ruta de acceso |
| Nombre, Tipo, Descripción |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de estado de respuesta HTTP para "Get announcement banner for enterprise"
| status code | Descripción |
|---|---|
200 | OK |
Ejemplos de código para "Get announcement banner for enterprise"
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/enterprises/ENTERPRISE/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 enterprise
Sets the announcement banner to display for the enterprise.
Parámetros para "Set announcement banner for enterprise"
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
accept string Setting to |
| Parámetros de la ruta de acceso |
| Nombre, Tipo, Descripción |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Parámetros del cuerpo |
| Nombre, Tipo, Descripción |
announcement string or null RequeridoThe 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: |
Códigos de estado de respuesta HTTP para "Set announcement banner for enterprise"
| status code | Descripción |
|---|---|
200 | OK |
Ejemplos de código para "Set announcement banner for enterprise"
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/enterprises/ENTERPRISE/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 enterprise
Removes the announcement banner currently set for the enterprise.
Parámetros para "Remove announcement banner from enterprise"
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
accept string Setting to |
| Parámetros de la ruta de acceso |
| Nombre, Tipo, Descripción |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de estado de respuesta HTTP para "Remove announcement banner from enterprise"
| status code | Descripción |
|---|---|
204 | No Content |
Ejemplos de código para "Remove announcement banner from enterprise"
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/enterprises/ENTERPRISE/announcementResponse
Status: 204