#Удалить элемент

DELETE /v1/items/:entityTypeId/:id

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

#Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа смарт-процесса. Получить: GET /v1/smart-processes. Зарезервированные значения (1, 2, 3, 4, 7, 31) обслуживаются специализированными API: /v1/leads, /v1/deals, /v1/contacts, /v1/companies, /v1/quotes, /v1/invoices
id (path) number да ID элемента

#Примеры

В примерах entityTypeId = 177, id = 783 — замените на ваши значения.

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

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

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/items/177/783" \
  -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/177/783', {
  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/177/783', {
  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

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

400 — зарезервированный entityTypeId (для стандартных CRM-сущностей):

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_DYNAMIC_PARAM",
    "message": "entityTypeId 2 has a dedicated API: use /v1/deals instead"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_DYNAMIC_PARAM entityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
404 ENTITY_NOT_FOUND Элемент с указанным ID не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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