Удалить воронку

DELETE /v1/categories/:entityTypeId/:id

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

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа CRM-сущности. Для сделок 2, для счетов 31, для смарт-процесса — значение из GET /v1/smart-processes
id (path) number да Идентификатор воронки

Примеры

В примерах entityTypeId = 2 (сделки), id = 15 — замените на ваши значения.

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/categories/2/15" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/categories/2/15', {
  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/categories/2/15', {
  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 — воронка с указанным id не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Воронка с указанным id не найдена — сообщение Элемент не найден
404 ENTITY_NOT_FOUND entityTypeId не соответствует существующему типу — сообщение Смарт-процесс не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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