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

POST /v1/workflows/start

Запускает экземпляр бизнес-процесса по шаблону для указанной CRM-сущности. Возвращает уникальный идентификатор запущенного экземпляра.

#Поля запроса (body)

Поле Тип Обяз. Описание
templateId number ★ ID шаблона бизнес-процесса. Источник: GET /v1/entities/bizproc-templates
entityType string ★ Тип CRM-сущности: deal, lead, contact, company
entityId number ★ ID CRM-сущности. Источник: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies
parameters object нет Значения параметров шаблона. Набор полей определяется конкретным шаблоном в Битрикс24

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/start \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateId":713,"entityType":"deal","entityId":5141}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workflows/start \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"templateId":713,"entityType":"deal","entityId":5141}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/start', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    templateId: 713,
    entityType: 'deal',
    entityId: 5141,
  }),
})
const data = await res.json()
console.log(data.data.workflowId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows/start', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    templateId: 713,
    entityType: 'deal',
    entityId: 5141,
  }),
})
const data = await res.json()

#Поля ответа

Поле Тип Описание
success boolean true при успешном запуске
data.workflowId string Уникальный идентификатор запущенного экземпляра бизнес-процесса

#Пример ответа

HTTP 201 Created

JSON 
{
  "success": true,
  "data": {
    "workflowId": "69f0c2d5ade389.22457798"
  }
}

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

400 — не переданы обязательные параметры:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: templateId (number), entityType (\"deal\"|\"lead\"|\"contact\"|\"company\"), entityId (number)"
  }
}

#Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не передан один или несколько обязательных параметров: templateId, entityType, entityId
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 отказал в доступе
422 BITRIX_ERROR Ошибка на стороне Битрикс24 — например, шаблон с указанным templateId не найден
429 RATE_LIMITED Превышен лимит запросов. Повторите через 1–2 секунды
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

  • Один шаблон — несколько экземпляров. Один и тот же templateId можно запустить для разных сущностей одновременно. Каждый запуск получает отдельный уникальный workflowId.

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