#Завершить бизнес-процесс

DELETE /v1/workflows/:id

Завершает запущенный экземпляр бизнес-процесса. По умолчанию выполняет мягкое завершение — дожидается окончания текущего шага. С параметром ?force=true принудительно прерывает процесс немедленно.

#Параметры

Параметр В Тип Обяз. Описание
id path string да Идентификатор экземпляра бизнес-процесса. Источник: GET /v1/workflows, поле ID
force query string нет true — принудительное завершение без ожидания текущего шага
status query string нет Причина завершения — произвольный текст, передаётся в Битрикс24

#Примеры

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/workflows/69f0c2d5ade389.22457798 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/workflows/69f0c2d5ade389.22457798 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/workflows/69f0c2d5ade389.22457798',
  { 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/workflows/69f0c2d5ade389.22457798',
  {
    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": "Бизнес-процесс не найден"
  }
}

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или недействительный API-ключ
401 TOKEN_MISSING У ключа нет подключённых токенов Битрикс24
401 TOKEN_EXPIRED Пользовательская сессия OAuth истекла — повторите авторизацию через /v1/oauth/authorize
403 SCOPE_DENIED Ключу не хватает скоупа bizproc
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
404 ENTITY_NOT_FOUND Экземпляр бизнес-процесса с указанным id не найден
429 RATE_LIMITED Превышен лимит запросов. Повторите через 1–2 секунды
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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