# bizproc.workflow.start

URL: https://chugunov.pro/api-bitrix24/bizproc/bizproc-workflow-start/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Запустить бизнес-процесс
Scope: `bizproc`
Кто может выполнять метод: администратор

## Описание

Метод `bizproc.workflow.start` запускает новый бизнес-процесс.

Запустить бизнес-процесс используя REST можно только на платных тарифах, demo лицензиях и лицензиях NFR.

## Параметры

- `TEMPLATE_ID` `integer` — обязательный. Идентификатор шаблона бизнес-процесса
- `DOCUMENT_ID` `array` — обязательный. Идентификатор документа для запуска бизнес-процесса в формате [`модуль`, `объект`, `ID_элемента`].
  Примеры записей для разных вариантов документов:
  - Лид — `['crm', 'CCrmDocumentLead', 'LEAD_777']`
  - Компания — `['crm', 'CCrmDocumentCompany', 'COMPANY_777']`
  - Контакт — `['crm', 'CCrmDocumentContact', 'CONTACT_777']`
  - Сделка — `['crm', 'CCrmDocumentDeal', 'DEAL_777']`
  - Коммерческое предложение — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE_777']`
  - Файл диска — `['disk', 'Bitrix\Disk\BizProcDocument', '777']`
  - Документ процессов в ленте новостей — `['lists', 'BizprocDocument', '777']`
  - Документ списков — `['lists', 'Bitrix\Lists\BizprocDocumentLists', '777']`
  - Элемент смарт-процесса — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_147_1']`, где `147` — это `ID` смарт-процесса, `1` — `ID` элемента смарт-процесса
  - Счет — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE_3']`
- `PARAMETERS` `object` — необязательный. Значения параметров шаблона бизнес-процесса.
  Используется, если у шаблона есть параметры.
  Для передачи значения в параметр типа «Привязка к пользователю» используйте запись вида `user_ID`. Например:
  ```php
  PARAMETERS: {
      'resp_employee': user_14 // ID сотрудника — 14
  }
  ```

## Ответ

HTTP-статус: 200

```json
{
    "result": "66e81a641752f8.56521481",
    "time": {
        "start": 1726476060.581428,
        "finish": 1726476060.813776,
        "duration": 0.23234796524047852,
        "processing": 0.002630949020385742,
        "date_start": "2024-09-16T08:41:00+00:00",
        "date_finish": "2024-09-16T08:41:00+00:00",
        "operating_reset_at": 1726476660,
        "operating": 0,
    },
}
```

### Возвращаемые данные

- `result` `string`. Корневой элемент ответа.
  Возвращает идентификатор запущенного бизнес-процесса
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_WRONG_WORKFLOW_ID",
    "error_description": "Empty TEMPLATE_ID",
}
```

- `400` — `ERROR_WRONG_WORKFLOW_ID`. Empty TEMPLATE_ID
- `400` — `ERROR_WRONG_WORKFLOW_ID`. Template not found
- `400` — Пустое значение. Wrong DOCUMENT_ID!
- `400` — Пустое значение. Incorrect document type!
- `400` — Пустое значение. Template type and DOCUMENT_ID mismatch!
- `403` — `ACCESS_DENIED`. Access denied!

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.start
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.workflow.start
```

### JS

```js
try
{
	const response = await $b24.callMethod(
		'bizproc.workflow.start',
		{
			TEMPLATE_ID: 1,
			DOCUMENT_ID: [
				'crm',
				'CCrmDocumentLead',
				'LEAD_1'
			],
			PARAMETERS: {
				'Parameter1': 'user_1'
			},
		}
	);
	
	const result = response.getData().result;
	console.log('response', result.answer);
	if (result.error())
		alert("Error: " + result.error());
	else
		console.log(result);
}
catch( error )
{
	console.error('Error:', error);
}
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.workflow.start(
        template_id=1,
        document_id=(
            "crm",
            "CCrmDocumentLead",
            "LEAD_1",
        ),
        parameters={
            "Parameter1": "user_1",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'bizproc.workflow.start',
            [
                'TEMPLATE_ID' => 1,
                'DOCUMENT_ID' => [
                    'crm',
                    'CCrmDocumentLead',
                    'LEAD_1'
                ],
                'PARAMETERS' => [
                    'Parameter1' => 'user_1'
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error starting workflow: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(	
    'bizproc.workflow.start',
    {
        TEMPLATE_ID: 1,
        DOCUMENT_ID: [
            'crm',
            'CCrmDocumentLead',
            'LEAD_1'
        ],
        PARAMETERS: {
            'Parameter1': 'user_1'
        },
    },
    function(result) {
        console.log('response', result.answer);
        if(result.error())
            alert("Error: " + result.error());
        else
        console.log(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'bizproc.workflow.start',
    [
        'TEMPLATE_ID' => 1,
        'DOCUMENT_ID' => [
            'crm',
            'CCrmDocumentLead',
            'LEAD_1'
        ],
        'PARAMETERS' => [
            'Parameter1' => 'user_1'
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.workflow.start", b24.Params{
	"TEMPLATE_ID": 1,
	"DOCUMENT_ID": []string{"crm", "CCrmDocumentLead", "LEAD_1"},
	"PARAMETERS": b24.Params{
		"Parameter1": "user_1",
	},
})
if err != nil {
	return fmt.Errorf("bizproc.workflow.start: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-start.html