## Закрепить сообщение для себя

`POST /v1/chats/messages/:messageId/pin/personal`

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|-----------|------|----------|-------------|
| `messageId` (path) | integer | да | ID сообщения из [истории сообщений](/docs/chats/messages/list) |

Нужен скоуп `im`. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются.

Тело может отсутствовать либо быть `{}`. Поля тела и параметры запроса не принимаются. Нужен ключ с правом записи.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()
console.log(data)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log(data)
```

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

| Поле | Тип | Описание |
|-------|------|-------------|
| `success` | boolean | `true` |
| `data` | array | Пустой массив — сообщение закреплено |

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

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

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

400 — передан неизвестный параметр:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `ownerId` is not accepted by POST /v1/chats/messages/:messageId/pin/personal. It takes no query parameters."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Некорректный ID, неизвестный или повторный параметр либо поле тела |
| 422 | `BITRIX_ERROR` | `error.b24Code` равен `MESSAGE_NOT_FOUND` — сообщения с таким ID нет |
| 422 | `BITRIX_ERROR` | `error.b24Code` равен `MESSAGE_IS_ALREADY_PERSONAL_PIN` — сообщение уже в личных закрепах |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | Нет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `im` |
| 403 | `BITRIX_ACCESS_DENIED` | У текущего пользователя нет доступа |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключу запрещено менять данные Битрикс24 |
| 404 | `ENTITY_NOT_FOUND` | Запись не найдена |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил операцию с другим кодом, он — в `error.b24Code` |

Общие ошибки API — [Ошибки](/docs/errors).

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

- [Конфигурация чата](/docs/chats/discovery/configuration)
- [Сообщения](/docs/chats/messages)
