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

Удалить документ

DELETE /v1/note/documents/:id

Перемещает документ вместе со всем его поддеревом в корзину. Восстановить документ через API нельзя — это доступно только в интерфейсе Битрикс24.

Параметры

Параметр Где Тип Обяз. Описание
id path integer да Идентификатор корневого документа поддерева

Примеры

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/note/documents/77 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/note/documents/77 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data.deleted) // true

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

Ответ

При успешном удалении возвращается объект { deleted: true }.

Поле Тип Описание
data.deleted boolean true при успешном удалении

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

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

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

404 — документ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999` не найдена"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не положительное целое
403 WRITE_BLOCKED_READONLY_KEY Ключ доступа работает только на чтение
403 BITRIX_ACCESS_DENIED Нет права редактировать документ
404 ENTITY_NOT_FOUND Документ не существует или уже в корзине
403 SCOPE_DENIED Ключу не хватает скоупа note
401 TOKEN_MISSING У ключа не настроены токены

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

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

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