Удалить поле

DELETE /v1/lists/:iblockId/fields/:fieldId

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

Параметры

Параметр Тип Обяз. Описание
iblockId (path) string да Идентификатор списка — числовой IBLOCK_ID или символьный IBLOCK_CODE. Список списков: GET /v1/lists
fieldId (path) string да Идентификатор поля в форме PROPERTY_<число> или символьный код. Список полей: GET /v1/lists/:iblockId/fields
iblockTypeId (query) string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы

Примеры

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177', {
  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/lists/23/fields/PROPERTY_1177', {
  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/1.1 204 No Content

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

403 — нет прав на список:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Нет прав для просмотра и редактирования списка."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet
422 BITRIX_ERROR Битрикс24 отклонил удаление, текст в message
403 BITRIX_ACCESS_DENIED Нет прав на редактирование списка
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа нет настроенных токенов
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале

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

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