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

Удалить значение списочного поля

DELETE /v1/userfields/:entity/enum-values/:id

Удаляет один вариант списочного пользовательского поля CRM. Восстановить удалённый вариант через API нельзя.

Доступность. Возможность включается администратором и требует обновления CRM после версии 26.2200.0. Номер выпущенной версии ещё не определён. Если возможность недоступна, API возвращает 422 METHOD_NOT_YET_AVAILABLE с полем error.release.

Альтернативный путь для смарт-процессов и счетов: DELETE /v1/items/:entityTypeId/userfields/enum-values/:id.

Параметры

Параметр Тип Обяз. Описание
Параметрentity (path) Типstring Обяз.да Описаниеdeals, leads, contacts, companies, quotes, invoices
Параметрid (path) Типnumber Обяз.да ОписаниеID значения. Источник: список значений
ПараметрentityTypeId (path) Типnumber Обяз.да для альтернативного пути ОписаниеДля альтернативного пути: ID смарт-процесса или 31 для счетов

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119', {
  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/userfields/deals/enum-values/4119', {
  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

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

404 — повторное удаление уже удалённого значения:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный тип или форма параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторяющийся параметр запроса
HTTP401 КодMISSING_API_KEY ОписаниеНе передан API-ключ
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права на операцию в Битрикс24
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч разрешает только чтение
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗначение списка не найдено
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность выключена или недоступна на портале. Целевое обновление указано в error.release
HTTP422 КодBITRIX_ERROR ОписаниеОтказ Битрикс24. Причина в error.message
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул некорректный ответ

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

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