#Удалить реквизит

DELETE /v1/requisites/:id

Удаляет реквизит по ID. Привязанные к реквизиту адреса и банковские реквизиты удаляются вместе с ним на уровне Битрикс24.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID реквизита

#Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/requisites/42" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/requisites/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisites/42', {
  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/requisites/42', {
  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

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

404 — реквизит не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Requisite with ID '999999999' is not found"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Реквизит с таким ID не найден
403 ACCESS_DENIED Нет доступа к родительской сущности
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Удаление каскадное. Вместе с реквизитом удаляются привязанные к нему адреса и банковские реквизиты — это поведение Битрикс24, оно не настраивается.

Мягкое удаление отсутствует. После удаления восстановить реквизит нельзя — создавайте новый. Если нужен временный «отказ от использования», используйте поле active: false через обновление.

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