## Закрепить чат

`POST /v1/chats/:dialogId/pin`

Закрепляет чат в списке диалогов текущего пользователя: закреплённые чаты стоят в начале списка на каждой странице. Закрепляется чат целиком, а не сообщение в нём.

## Параметры

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

Тело запроса не передаётся. Любой параметр запроса или поле тела отклоняется с `400 INVALID_PARAMS`.

## Примеры

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

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

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/chats/chat456/pin \
  -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/chat456/pin', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

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

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

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

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.result` | boolean | `true` — чат закреплён. Повторный вызов для уже закреплённого чата тоже отвечает `true` |

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

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

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

422 — чата с таким `dialogId` нет на портале:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "CHAT_NOT_FOUND",
    "hint": "dialogId must be a userId (number as string) for DMs or \"chat{N}\" for group chats. Examples: \"1\" for user 1, \"chat123\" for group chat 123. Create a group chat first via POST /v1/bots/:botId/chats if needed.",
    "b24Code": "CHAT_NOT_FOUND"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Передан параметр запроса или поле тела. Проверяется до обращения к Битрикс24 |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`. `FOLDER_PINS_LIMIT_EXCEEDED` — уже закреплено 45 чатов. `CHAT_NOT_FOUND` — чата с таким `dialogId` нет |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено», код портала — в `error.b24Code` |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Не удалось определить пользователя при использовании алиаса `me` |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя нет доступа к чату |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения: закреп — запись, см. [права доступа](/docs/access-rights) |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

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

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

**Закреп чата и закреп сообщения — разные операции.** Этот эндпоинт поднимает чат в начало списка диалогов. Закреп сообщения внутри чата — отдельный путь `POST /v1/chats/messages/:messageId/pin`, где в пути стоит ID сообщения.

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

**Вызов может сделать вас участником.** Если чат разрешает автовступление — например, чат комментариев, коллаб или чат задачи, — закреп добавляет текущего пользователя в участники так же, как открытие чата в интерфейсе Битрикс24.

**Лимит — 45 закреплённых чатов на пользователя.** Чтобы закрепить ещё один, сначала [открепите](/docs/chats/management/unpin) лишний.

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

- [Порядок закреплённого чата](/docs/chats/management/pin-sort)
- [Открепить чат](/docs/chats/management/unpin)
- [Последние диалоги](/docs/chats/discovery/recent)
- [Управление чатами](/docs/chats/management)