# Справочник API по общим уведомлениям

Source: https://instatus.com/help/ru/api/generic-notices

Общие уведомления — это постоянные баннеры на вашей странице статуса, отдельные от инцидентов и обслуживаний. Эти эндпоинты позволяют управлять ими программно.

## Получить все общие уведомления

**Эндпоинт:**

```bash
GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page
```

- Номер страницы по умолчанию — 1.
- Значение per_page по умолчанию — 50, максимум — 100 элементов на страницу.

**Пример ответа:**

```json
[
  {
    "id": "cl9mq0ah50646mpvlmbrvf979",
    "name": "Scheduled DNS migration",
    "message": "We are migrating our DNS provider over the next week.",
    "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
    "notify": false,
    "isCollapsed": false,
    "createdAt": "2022-10-24T11:53:46.505Z",
    "updatedAt": "2022-10-24T11:53:46.505Z",
    "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
    "importedFrom": null
  }
]
```

## Получить общее уведомление

**Эндпоинт:**

```bash
GET /v1/:page_id/generic-notices/:generic_notice_id
```

**Пример ответа:**

```json
{
  "id": "cl9mq0ah50646mpvlmbrvf979",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-10-24T11:53:46.505Z",
  "updatedAt": "2022-10-24T11:53:46.505Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}
```

## Добавить общее уведомление

**Эндпоинт:**

```bash
POST /v1/:page_id/generic-notices
```

**Параметры тела запроса:**

- `name` (обязательно) — заголовок уведомления.
- `message` — текст уведомления. Поддерживается HTML.
- `notify` — уведомлять ли подписчиков. По умолчанию `false`.
- `isCollapsed` — свёрнуто ли уведомление по умолчанию. По умолчанию `false`.
- `translations` — необязательные переводы для `name` и `message` с ключами по коду языка.

**Пример запроса:**

```json
{
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "notify": false,
  "isCollapsed": false,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}
```

**Пример ответа:**

```json
{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-01T03:52:08.126Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}
```

## Обновить общее уведомление

**Эндпоинт:**

```bash
PUT /v1/:page_id/generic-notices/:generic_notice_id
```

Обновляются только те поля, которые вы передали.

**Пример запроса:**

```json
{
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "isCollapsed": true
}
```

**Пример ответа:**

```json
{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}
```

## Удалить общее уведомление

**Эндпоинт:**

```bash
DELETE /v1/:page_id/generic-notices/:generic_notice_id
```

**Пример ответа:**

```json
{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}
```