## Задать папки чата

`PUT /v1/chats/:dialogId/folders`

Помещает чат ровно в перечисленные личные папки текущего пользователя: в указанные папки чат добавляется, из остальных личных папок — убирается.

Вызов изменяющий: ключ только для чтения получает `403 WRITE_BLOCKED_READONLY_KEY` до обращения к Битрикс24.

Не путайте с [`GET /v1/chats/:chatId/folder`](/docs/chats/files/folder) — это папка чата на Диске, а не папка списка чатов.

## Параметры

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

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `folderIds` | number[] | да | ID личных папок, в которых должен оказаться чат, — поле `id` папок с `type: "personal"` из [`GET /v1/chats/folders`](/docs/chats/discovery/folders). Элемент — положительное целое: число или строка из цифр без ведущих нулей. `[]` убирает чат из всех личных папок |

Параметров запроса нет. Любой параметр запроса или другое поле тела отклоняется с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/chat42/folders" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"folderIds": [15, 16]}'
```

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

```bash
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/chat42/folders" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"folderIds": [15, 16]}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/folders', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ folderIds: [15, 16] }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/folders', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ folderIds: [15, 16] }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.result` | boolean | `true` — запись выполнена. Итоговый состав папок — [`GET /v1/chats/folders/:folderId`](/docs/chats/management/folders-get) |

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

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

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

400 — не передан `folderIds`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`folderIds` is missing: pass the full list of the personal folders of the chat (`[]` takes it out of all of them)."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Нет `folderIds`, `folderIds` не массив или его элемент не положительное целое, передан параметр запроса или неизвестное поле тела, тело — не JSON-объект. Проверяется до обращения к Битрикс24 |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено», код портала — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`: `FOLDER_CHATS_LIMIT_EXCEEDED` — в папке было бы больше 50 чатов, `FOLDER_CHAT_NOT_ELIGIBLE` — пользователь не состоит в чате или чат не подходит по типу, `CHAT_NOT_FOUND` — чата нет на портале |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Не удалось определить пользователя при использовании алиаса `me` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения — вызов меняет состав папок |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |

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

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

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

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

- [Добавить чаты в папку](/docs/chats/management/folder-chats)
- [Убрать чаты из папки](/docs/chats/management/folder-chats-delete)
- [Создать папку чатов](/docs/chats/management/folders-create)
- [Изменить папку чатов](/docs/chats/management/folders-update)
- [Папки чатов](/docs/chats/discovery/folders)
- [Чаты папки](/docs/chats/discovery/folder-recent)