Start a business process bizproc.workflow.start

Scope: bizproc

Who can execute the method: administrator

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

You can only start a business process using REST on paid plans, demo licenses, and NFR licenses.

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`, `ID_element`]. 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']` Drive file — `['disk', 'Bitrix\\Disk\\BizProcDocument', '777']` News feed process document — `['lists', 'BizprocDocument', '777']` Lists 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 of the business process template parameters. Used if the template has parameters. To pass a value to a parameter of type "User binding," use the format `user_ID`. For example: `PARAMETERS: { 'resp_employee': user_14 // Employee ID — 14 }`

Code Examples

cURL (Webhook)

cURL (OAuth)

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

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 logic for processing data
            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>';

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 request execution time

Error Handling

HTTP status: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`ERROR_WRONG_WORKFLOW_ID`	Empty TEMPLATE_ID	An empty input parameter `TEMPLATE_ID` was provided
`400`	`ERROR_WRONG_WORKFLOW_ID`	Template not found	The business process template was not found for the provided `TEMPLATE_ID`
`400`	Empty value	Wrong DOCUMENT_ID!	An incorrect `DOCUMENT_ID` was provided
`400`	Empty value	Incorrect document type!	Unable to determine the 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 the wrong entity for which it was created
`403`	`ACCESS_DENIED`	Access denied!	The method was not executed by an administrator

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview

Get List of Workflows

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