Start Business Process bizproc.workflow.start

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: bizproc

Who can execute the method: administrator

The method bizproc.workflow.start initiates a new business process.

To call this method, your Bitrix24 account must have REST API access. In Bitrix24 Cloud, Vibe+ plans include this access; it is also available during the 15-day trial and may remain active under existing subscription terms during the transition period.

Method Parameters

Required parameters are marked with *

Name `type`	Description
TEMPLATE_ID* `integer`	Identifier of the business process template
DOCUMENT_ID* `array`	Identifier of the document to start the business process in the format [`module`, `object`, `ELEMENT_ID`]. Examples of entries for different document types: Lead — `['crm', 'CCrmDocumentLead', 'LEAD_777']` Company — `['crm', 'CCrmDocumentCompany', 'COMPANY_777']` Contact — `['crm', 'CCrmDocumentContact', 'CONTACT_777']` Deal — `['crm', 'CCrmDocumentDeal', 'DEAL_777']` Estimate — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE_777']` Drive file — `['disk', 'Bitrix\Disk\BizProcDocument', '777']` Document in news feed — `['lists', 'BizprocDocument', '777']` List document — `['lists', 'Bitrix\Lists\BizprocDocumentLists', '777']` Smart process element — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_147_1']`, where `147` is the `ID` of the smart process, and `1` is the `ID` of the smart process element Invoice — `['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE_3']`
PARAMETERS `object`	Values for the parameters of the business process template. Used if the template has parameters. To pass a value to a parameter of the "User binding" type, use the format `user_ID`. For example: `PARAMETERS: { 'resp_employee': user_14 // Employee ID — 14 }`

Code Examples

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

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 -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

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);
        }

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

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);
            // Your data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error starting workflow: ' . $e->getMessage();
        }

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());
            }
        );

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>';

// client and ctx are already created — see the Go SDK section
        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)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP Status: 200

{
            "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
            }
        }

Returned Data

Name
type

Description

result
string

Root element of the response.

Returns the identifier of the started business process

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

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

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`ERROR_WRONG_WORKFLOW_ID`	Empty TEMPLATE_ID	Empty input parameter `TEMPLATE_ID` was passed
`400`	`ERROR_WRONG_WORKFLOW_ID`	Template not found	Business process template not found for the provided `TEMPLATE_ID`
`400`	Empty value	Wrong DOCUMENT_ID!	Incorrect `DOCUMENT_ID` was passed
`400`	Empty value	Incorrect document type!	Unable to determine document type from the provided `DOCUMENT_ID`
`400`	Empty value	Template type and DOCUMENT_ID mismatch!	The document type in the template does not match the type determined from `DOCUMENT_ID`. Attempting to start the template on an entity for which it was not created
`403`	`ACCESS_DENIED`	Access denied!	Method was not executed by an administrator

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Overview of Methods

Get List of Workflows

Start Business Process bizproc.workflow.start

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning