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

Удалить поле

DELETE /v1/items/:entityTypeId/userfields/:id

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

Параметры

Параметр Тип Обяз. Описание
Параметр:entityTypeId (path) Типnumber Обяз.да ОписаниеИдентификатор типа смарт-процесса. Источник: GET /v1/smart-processes — поле entityTypeId в каждом элементе массива data
Параметр:id (path) Типnumber Обяз.да ОписаниеЧисловой идентификатор поля (из ответа GET /v1/items/:entityTypeId/userfields или POST /v1/items/:entityTypeId/userfields)

Примеры

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/items/174/userfields/8210" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/items/174/userfields/8210" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/items/174/userfields/8210',
  {
    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/items/174/userfields/8210',
  {
    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
HTTP/1.1 204 No Content

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

403 — у ключа нет скоупа userfieldconfig:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "The request requires higher privileges than provided by the webhook token"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_ENTITY_TYPE_ID Описание:entityTypeId не является положительным целым числом
HTTP400 КодINVALID_PARAMS Описание:id не является положительным целым числом либо превышает 9007199254740991. Значение записывается только цифрами — без ведущего нуля, знака, дробной части, экспоненты и пробелов. Поле не удаляется
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ ключа нет скоупа userfieldconfig — перевыпустите ключ с этим скоупом
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP404 КодSMART_PROCESS_NOT_FOUND ОписаниеСмарт-процесс с указанным entityTypeId не найден на портале
HTTP404 КодENTITY_NOT_FOUND ОписаниеУ смарт-процесса из пути нет поля с указанным id: поле уже удалено или принадлежит другой сущности. Удаление не выполняется
HTTP422 КодBITRIX_ERROR ОписаниеПоле удалили между проверкой и удалением — Битрикс24 отвечает «Вы не можете удалить пользовательское поле»
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP401 КодMISSING_API_KEY ОписаниеОтсутствует заголовок X-Api-Key

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

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

Значения в элементах удаляются безвозвратно. При удалении поля все его значения в существующих элементах смарт-процесса теряются. Если поле используется в автоматизациях, роботах или интеграциях — проверьте зависимости перед удалением.

Удаляется только поле смарт-процесса из пути. Идентификатор поля общий для всех сущностей портала, поэтому перед удалением платформа проверяет, что поле с этим id есть у смарт-процесса :entityTypeId. Поле другой сущности не удаляется, ответ — 404 ENTITY_NOT_FOUND.

Повторное удаление. Повторный DELETE на том же id возвращает 404 ENTITY_NOT_FOUND: поле уже удалено.

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