## Непрочитано с сообщения

`POST /v1/chats/messages/:messageId/unread`

Делает указанное сообщение первым непрочитанным в диалоге, не отмечая непрочитанным весь чат, как это делает отметка чата целиком.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `messageId` (path) | number | да | ID сообщения, положительное целое — поле `id` сообщения из [ленты](/docs/chats/messages/list) или [загрузки чата](/docs/chats/messages/load) |

Параметров запроса нет: любой параметр отклоняется с `400 INVALID_PARAMS`.

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `dialogId` | string \| number | да | Диалог, в котором лежит сообщение: `chatXXX` для группового чата, ID пользователя для личного, `me` — личный диалог текущего пользователя. `chatXXX` — поле `id` строки [последних диалогов](/docs/chats/discovery/recent), ID пользователя — из [списка пользователей](/docs/entities/users/list) |

Другие поля тела отклоняются с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/1001/unread" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "dialogId": "chat42" }'
```

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

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

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

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

const { success } = await res.json()
console.log('Отметка поставлена:', success)
```

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

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

const { success } = await res.json()
console.log('Отметка поставлена:', success)
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | boolean | `true` — отметка поставлена |

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

```json
{
  "success": true,
  "data": true
}
```

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

404 — сообщения нет в указанном диалоге:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Message is not in the specified dialog. Nothing was changed."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `messageId` не положительное целое или равен `9007199254740991`, `dialogId` не передан или не похож на ID пользователя, `chatXXX` или `me`, передано другое поле тела или параметр запроса. Проверяется до обращения к Битрикс24 |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение. Проверяется до обращения к Битрикс24 |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал в доступе |
| 404 | `ENTITY_NOT_FOUND` | Сообщения нет в указанном диалоге или оно из другого диалога. Отметка не ставится |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в операции, текст отказа — в `error.message` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов к Битрикс24. Повторите запрос после паузы из заголовка `Retry-After` |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Не удалось определить текущего пользователя для `me` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен, вернул ошибку сервера или не подтвердил отметку |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя, и неизвестно, поставлена ли отметка. Повторите запрос после паузы из заголовка `Retry-After` |

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

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

У сообщений и чатов три разные отметки — выбирайте по задаче:

| Маршрут | Действие |
|---|---|
| [`POST /v1/chats/:dialogId/unread`](/docs/chats/management/unread-create) | Отметить весь чат непрочитанным |
| [`POST /v1/chats/messages/:messageId/mark`](/docs/chats/messages/mark) | Указатель «прочитать позже». Существующую метку не перемещает |
| `POST /v1/chats/messages/:messageId/unread` | Сделать сообщение первым непрочитанным в указанном диалоге |

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

- [Поставить метку «непрочитано»](/docs/chats/management/unread-create)
- [Прочитать позже](/docs/chats/messages/mark)
- [Сообщения](/docs/chats/messages)
- [Ошибки](/docs/errors)
