---
title: "Enterprise Announcement"
url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/announcement"
---

> Full API specification: https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4.md

# Enterprise Announcement

Enterprise global announcement

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: GitHub v3 REST API
  version: 1.1.4
servers:
  - url: "{protocol}://{hostname}/api/v3"
    variables:
      hostname:
        description: Self-hosted Enterprise Server or Enterprise Cloud hostname
        default: HOSTNAME
      protocol:
        description: Self-hosted Enterprise Server or Enterprise Cloud protocol
        default: http
components:
  schemas:
    announcement-message:
      type: string
      description: The announcement text in GitHub Flavored Markdown. For more
        information about GitHub Flavored Markdown, see "[Basic writing and
        formatting
        syntax](https://docs.github.com/enterprise-server@3.0/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."
      example: Very **important** announcement about _nothing_.
    announcement-expiration:
      type: string
      format: date-time
      description: "The time at which the announcement expires. This is a timestamp in
        [ISO 8601](https://en.wikipedia.org/wiki/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."
      example: '"2021-01-01T00:00:00.000-07:00"'
      nullable: true
    announcement:
      title: Enterprise Announcement
      description: Enterprise global announcement
      type: object
      properties:
        announcement:
          $ref: "#/components/schemas/announcement-message"
        expires_at:
          $ref: "#/components/schemas/announcement-expiration"
      required:
        - announcement
```