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

Удалить поле сотрудника

DELETE /v1/userfields/users/:id

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

Параметры

Параметр Тип Обяз. Описание
:id (path) number да Числовой идентификатор поля (из ответа GET /v1/userfields/users или POST /v1/userfields/users)

Примеры

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/userfields/users/6007923" \
  -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/users/6007923', {
  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/users/6007923', {
  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 — поля с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "User field 999999999 not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_ID :id не является положительным целым числом — запрос отклонён до обращения к порталу
404 ENTITY_NOT_FOUND Поля с таким id нет — в том числе повторный DELETE после успешного удаления
422 BITRIX_ERROR Владелец ключа не является администратором портала — Битрикс24 отвечает сообщением Access denied.
422 BITRIX_ERROR Другие отказы Битрикс24 — в том числе поле удалили между проверкой существования и самим удалением. Текст приходит в error.message дословно
403 SCOPE_DENIED API-ключ не имеет скоупа user.userfield
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
401 MISSING_API_KEY Отсутствует заголовок X-Api-Key

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

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

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

Поле сразу исчезает из схемы сотрудника. После удаления имя UF_USR_* пропадает из GET /v1/users/fields без задержки, а GET /v1/userfields/users/:id по прежнему id отвечает 404 NOT_FOUND. Повторный DELETE того же id отвечает 404 ENTITY_NOT_FOUND.

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