Для AI-агентов: markdown этой страницы — /docs-content/chats/management/folder-chats-delete.md индекс документации — /llms.txt

Убрать чаты из папки

DELETE /v1/chats/folders/:folderId/chats

Убирает чаты из личной папки текущего пользователя. Сами чаты и папка остаются.

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

Параметры

Параметр Тип Обяз. Описание
folderId (path) number да ID личной папки — поле id папки с type: "personal" из GET /v1/chats/folders
chatIds (query) string нет ID чатов через запятую: chatIds=42,57. ID чата — поле chatId последних диалогов, каждый — положительное целое
dialogIds (query) string нет Идентификаторы диалогов через запятую: dialogIds=chat42,7. chatXXX — поле dialogId последних диалогов, ID пользователя — из списка пользователей. Элемент — непустая строка до 64 символов без пробелов по краям. Алиас me не принимается — передайте ID пользователя

Нужен хотя бы один ID в chatIds или dialogIds. Списки передаются только в query. Любой другой параметр запроса, повтор параметра или поле тела отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/folders/16/chats?chatIds=42&dialogIds=chat57" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/folders/16/chats?chatIds=42&dialogIds=chat57" \
  -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/folders/16/chats?chatIds=42&dialogIds=chat57', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders/16/chats?chatIds=42&dialogIds=chat57', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — запись выполнена. Итоговый состав папки — GET /v1/chats/folders/:folderId

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

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

422 — папки с таким ID нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "FOLDER_NOT_FOUND",
    "b24Code": "FOLDER_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS folderId не положительное целое, нет ни одного ID в chatIds и dialogIds, некорректный элемент списка, неизвестный или повторный параметр запроса, передано поле тела, тело — не JSON-объект. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code: FOLDER_NOT_FOUND — папки нет, FOLDER_ACCESS_DENIED — папка другого пользователя, FOLDER_SYSTEM_MUTATION_FORBIDDEN — состав системной папки менять нельзя
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — вызов меняет состав папки
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

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

  • Чат, которого нет в папке, пропускается. Ответ успешный и тогда, когда ни одного из переданных чатов в папке не было.
  • ID пользователя в dialogIds не создаёт личный диалог, в отличие от добавления чатов в папку.
  • dialogIds работает начиная с обновления im 26.1000.0. В облачном Битрикс24 оно уже установлено. Коробочный Битрикс24 без этого обновления молча пропускает dialogIds, и запрос с одними dialogIds ответит успехом, ничего не изменив. На таком портале передавайте chatIds.

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