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

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

DELETE /v1/crm-documents/:id

Удаляет документ, созданный для записи CRM, без возможности восстановить его через API — при необходимости сформируйте новый.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа, положительное целое число. Список документов записи: GET /v1/crm-documents

Тело запроса не передаётся.

Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-documents/1969', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Документ удалён')
}

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

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

if (res.status === 204) {
  console.log('Документ удалён')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, не содержимое.

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

HTTP/1.1 204 No Content

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

404 — документа с таким id нет, в том числе при повторном удалении того же id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Документ не найден"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не положительное целое число, например 0 или abc. Сообщение: id must be a positive integer
404 ENTITY_NOT_FOUND Документа с таким id нет или он уже удалён
403 BITRIX_ACCESS_DENIED Нет доступа к записи CRM, к которой прикреплён документ, в том числе если такой записи нет. Сообщение: Access denied
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Ключу не сопоставлены токены — ключ OAuth-приложения вызван без пользовательской сессии

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

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