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

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

DELETE /v1/crm-document-templates/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор шаблона. Список: GET /v1/crm-document-templates

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

Примеры

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/crm-document-templates/263" \
  -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-document-templates/263', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const body = await res.json()
if (body.success) {
  console.log('Шаблон удалён')
}

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

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

const body = await res.json()
if (body.success) {
  console.log('Шаблон удалён')
}

Поля ответа

При успешном удалении возвращается HTTP-статус 200 OK.

Поле Тип Описание
success boolean true — шаблон удалён
data null Результат удаления, приходит null

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

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "CRM template not found."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не положительное целое число, например abc. Сообщение: Template ID must be a positive integer.
404 ENTITY_NOT_FOUND Шаблона с таким id нет, он уже удалён или принадлежит не модулю CRM. Шаблон при этом не удаляется. Шаблоны с moduleId: rest удаляет DELETE /v1/doc-templates/:id
422 BITRIX_ERROR Битрикс24 отклонил удаление. Текст причины — в error.message
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения. Удаление требует ключа с правом записи
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING У ключа нет настроенных токенов
429 RATE_LIMITED Битрикс24 ограничил частоту запросов к порталу. Повторите после срока из заголовка Retry-After

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

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