## Уведомления чата

`POST /v1/chats/:chatId/mute`

Выключает или включает уведомления из чата для пользователя, от имени которого идёт вызов. Остальных участников чата настройка не касается.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `chatId` (path) | number | да | ID чата (положительное целое). Чат сущности CRM находится через [Найти чат CRM-сущности](/docs/chats/discovery/find) |
| `mute` | boolean | да | `true` — выключить уведомления, `false` — включить обратно |

Вместо `mute` принимается `MUTE` со значением `"Y"` или `"N"` — в написании Битрикс24. Другие поля тела не передаются.

## Примеры

### curl — личный ключ

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/mute \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mute": false}'
```

### curl — OAuth-приложение

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/mute \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mute": false}'
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/456/mute', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ mute: false }),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/456/mute', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ mute: false }),
})

const { success, data } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.chatId` | number | ID чата из запроса |
| `data.muted` | boolean | Установленное состояние: `true` — уведомления выключены, `false` — включены |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "chatId": 456,
    "muted": false
  }
}
```

## Пример ответа при ошибке

400 — в теле нет поля `mute`:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Body field `mute` (boolean) is required: true switches the chat notifications off, false switches them back on."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_CHAT_ID` | `chatId` не является положительным целым числом — проверяется до обращения в Битрикс24 |
| 400 | `MISSING_PARAMS` | В теле нет `mute`, в том числе запрос без тела. В Битрикс24 ничего не отправлено |
| 400 | `INVALID_PARAMS` | `mute` не `true` / `false`, а `MUTE` не `"Y"` / `"N"`. В Битрикс24 ничего не отправлено |
| 404 | `CHAT_NOT_FOUND_OR_NO_ACCESS` | Чата нет, пользователь в нём не состоит или уведомления этого чата выключить нельзя |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ в режиме «только чтение» — настройка уведомлений считается записью |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Настройка личная.** Уведомления меняются только у того пользователя, от имени которого идёт вызов. С личным ключом это владелец ключа. Чтобы поменять настройку сотруднику, который открыл ваше приложение, вызывайте эндпоинт с ключом приложения и его сессией `vibe_session_*` в заголовке `Authorization` — так же, как в примерах для OAuth-приложения. Выключить уведомления за другого человека ключом администратора нельзя.

**Сессия сотрудника живёт 24 часа.** Сессия `vibe_session_*` появляется, когда сотрудник открывает приложение, и действует сутки. Если приложение реагирует на событие портала, например на добавление наблюдателя в задачу, у сотрудника, который давно не открывал приложение, действующей сессии нет, и вызов от его имени не пройдёт. Меняйте настройку в момент, когда сотрудник сам открыл приложение.

**`mute` обязателен.** Поле не угадывается: запрос без него отклоняется до обращения в Битрикс24. Так запрос, в котором поле потерялось, не выключит уведомления вместо того, чтобы их включить.

## Смотрите также

- [Покинуть чат](/docs/chats/management/leave)
- [Найти чат CRM-сущности](/docs/chats/discovery/find)
- [Управление чатами](/docs/chats/management)