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

Удалить форму

DELETE /v1/crm-forms/:id

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

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрid (path) Типinteger Обяз.да По умолч.— ОписаниеИдентификатор формы. Список: GET /v1/crm-forms
Параметрconfirm (query) Типboolean Обяз.нет По умолч.false Описаниеtrue подтверждает удаление активной формы. Без подтверждения активная форма не удаляется — ответ 409 CRM_FORM_DELETE_CONFIRMATION_REQUIRED. Выключенная форма удаляется и без confirm. Принимает только true или false
Параметрconfirmed (query) Типboolean Обяз.нет По умолч.— ОписаниеСиноним confirm. Если переданы оба параметра, значения должны совпадать, иначе 400 INVALID_PARAMS
ПараметрupdatedTime (query) Типstring Обяз.нет По умолч.— ОписаниеВремя последнего изменения формы из GET /v1/crm-forms/:id. Если форму изменили позже этого времени, удаление отклоняется с 409 CRM_FORM_VERSION_MISMATCH. Без параметра проверка версии не выполняется

Другие параметры строки запроса и любое поле тела возвращают 400 INVALID_PARAMS. Тело запроса не передаётся.

Тип и значение updatedTime проверяет Битрикс24. Используйте версию из ответа чтения формы; локальный отказ на неверный тип не гарантируется.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/crm-forms/75?confirm=true" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/crm-forms/75?confirm=true" \
  -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-forms/75?confirm=true', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const body = await res.json()
if (body.success && body.data.deleted) {
  console.log('Форма удалена')
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75?confirm=true', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const body = await res.json()
if (body.success && body.data.deleted) {
  console.log('Форма удалена')
}

Поля ответа

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

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

HTTP-статус 200 OK:

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

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

409 — форма активна, а удаление не подтверждено:

JSON 
{
  "success": false,
  "error": {
    "code": "CRM_FORM_DELETE_CONFIRMATION_REQUIRED",
    "message": "CRM-форма активна: подтвердите удаление и повторите запрос",
    "b24Code": "CRM_FORM_DELETE_CONFIRMATION_REQUIRED"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не положительное целое число, передан параметр строки запроса, кроме confirm, confirmed и updatedTime, confirm, confirmed или updatedTime передан дважды, значения подтверждений различаются, confirm не true и не false или передано поле тела
HTTP400 КодFST_ERR_CTP_EMPTY_JSON_BODY ОписаниеПередан заголовок Content-Type: application/json, а тело пустое. Уберите заголовок
HTTP402 КодCRM_FORM_WRITE_RESTRICTED ОписаниеТариф Битрикс24 не разрешает запись CRM-форм. На бесплатном и демо-тарифе запись не выполняется
HTTP403 КодCRM_FORM_SYSTEM_IMMUTABLE ОписаниеФорма системная — system: true в списке форм. Системную форму удалить нельзя
HTTP404 КодENTITY_NOT_FOUND ОписаниеФормы с таким id нет, в том числе при повторном удалении той же формы
HTTP409 КодCRM_FORM_DELETE_CONFIRMATION_REQUIRED ОписаниеФорма активна, а удаление не подтверждено
HTTP409 КодCRM_FORM_VERSION_MISMATCH ОписаниеФорму изменили после переданного updatedTime. Текущее время изменения — в error.currentUpdatedTime
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеУ токена Битрикс24 нет необходимого скоупа
HTTP409 КодCRM_FORM_REST_NOT_ENABLED ОписаниеНа портале выключены методы CRM-форм
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал пользователю ключа в доступе к форме
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24. Текст отказа — в error.message
HTTP500 КодCRM_FORM_SIDE_EFFECT_FAILED ОписаниеУдаление уже выполнено, но завершилось с ошибкой. Проверьте форму через GET /v1/crm-forms/:id до повтора
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или вернул ответ неожиданной формы. Проверьте форму до повтора
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа crm
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет действующей авторизации в Битрикс24

Ошибки портала содержат исходный код в error.b24Code и ошибки полей в error.validation, если они переданы. Коды CRM_FORM_* сохраняют HTTP-статус, код и сообщение. Ответы 429 и 503 описаны в разделе Лимиты и оптимизация. Полный список общих ошибок API — Ошибки.

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

  • Выключение вместо удаления. Чтобы форма перестала работать, а её настройки сохранились, выключите её — выключенную форму можно включить снова.

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