Для AI-агентов: markdown этой страницы — /docs-content/chats/management/folders-order.md индекс документации — /llms.txt
Изменить порядок папок чатов
PUT /v1/chats/folders/order
Сохраняет порядок папок чатов текущего пользователя в интерфейсе — системных и личных.
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
folderIds |
number[] | да | ID всех видимых папок пользователя в новом порядке: системных и личных. Каждый элемент — положительное целое: число или строка из цифр. ID папки — поле id в GET /v1/chats/folders |
Параметров запроса нет. Любой параметр запроса или другое поле тела отклоняется с 400 INVALID_PARAMS.
Примеры
curl — личный ключ
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/folders/order" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"folderIds": [27, 29, 31, 33, 35, 37, 127]}'
curl — OAuth-приложение
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/folders/order" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"folderIds": [27, 29, 31, 33, 35, 37, 127]}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders/order', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ folderIds: [27, 29, 31, 33, 35, 37, 127] }),
})
const { success, data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders/order', {
method: 'PUT',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({ folderIds: [27, 29, 31, 33, 35, 37, 127] }),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data.result |
boolean | true — порядок сохранён |
Пример ответа
{
"success": true,
"data": {
"result": true
}
}
Пример ответа при ошибке
422 — в folderIds перечислены не все видимые папки:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "FOLDER_SORT_INVALID",
"b24Code": "FOLDER_SORT_INVALID"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_PARAMS |
Нет folderIds, это не массив или элемент не положительное целое, передан параметр запроса или неизвестное поле тела, тело — не JSON-объект. Проверяется до обращения к Битрикс24 |
| 422 | BITRIX_ERROR |
Битрикс24 вернул ошибку, код портала — в error.b24Code: FOLDER_SORT_INVALID — набор folderIds не совпал с видимыми папками пользователя |
| 404 | ENTITY_NOT_FOUND |
Битрикс24 вернул «не найдено», код портала — в error.b24Code |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа im |
| 403 | WRITE_BLOCKED_READONLY_KEY |
Ключ только для чтения: порядок папок — запись, см. права доступа |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов Битрикс24 |
| 502 | BITRIX_UNAVAILABLE |
Битрикс24 недоступен или вернул ошибку сервера |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Набор для
folderIdsберите изGET /v1/chats/foldersпрямо перед вызовом. Папка, созданная или удалённая после чтения списка, делает набор устаревшим, и вызов вернётFOLDER_SORT_INVALID. - Значения
sortпортал пересчитывает сам. После вызова они могут отличаться от прежних даже при том же порядке папок.