Update Fields of the Automation Rule bizproc.robot.update

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 bizproc.robot.update method updates the fields of the Automation Rule registered by the application.

It only works in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Code of the Automation Rule that this application passed in `CODE` during registration. You can retrieve the codes using the bizproc.robot.list method
FIELDS* `object`	Object with fields of the Automation Rule

FIELDS Parameter

How the method updates the fields:

FIELDS must contain at least one field, otherwise the method returns the No fields to update error
PLACEMENT_HANDLER does not count as such a field: pass it together with another field, for example, USE_PLACEMENT: 'Y'
fields that are not included in FIELDS remain unchanged
PROPERTIES and RETURN_PROPERTIES are replaced entirely: to add a parameter, pass the full set

Name `type`	Description
HANDLER `string`	Handler URL to which Bitrix24 sends the Automation Rule data via the queue server. It must start with `http://` or `https://`, and the host name must contain a dot, for example, `https://example.com/robot.php`
AUTH_USER_ID `integer`	Identifier of the user whose token Bitrix24 passes to the handler by default. An administrator can select a different user in the Automation Rule settings
USE_SUBSCRIPTION `boolean`	Should the Automation Rule wait for a response from the application? Possible values: `Y` — yes `N` — no
NAME `string` \| `object`	Name of the Automation Rule. Can be a string or an associative array of localized strings like: `'NAME': { 'de': 'Automatisierungsregel Name', 'en': 'Automation rule name', ... },`
DESCRIPTION `string` \| `object`	Description of the Automation Rule. Can be a string or an associative array of localized strings like: `'DESCRIPTION': { 'de': 'Beschreibung der Automatisierungsregel', 'en': 'Automation rule description', ... },`
PROPERTIES `object`	Object with parameters of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule. The system name of the parameter must start with a letter and can contain characters `a-z`, `A-Z`, `0-9`, and underscore `_`
RETURN_PROPERTIES `object`	Object with additional results of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule. The application returns the values of these parameters using the bizproc.event.send method, and they become available to subsequent steps. Whether to wait for a response is set by the `USE_SUBSCRIPTION` parameter. The system name of the parameter must start with a letter and can contain characters `a-z`, `A-Z`, `0-9`, and underscore `_`
DOCUMENT_TYPE `array`	Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements: module identifier object identifier document type Possible value options: CRM Module `['crm', 'CCrmDocumentLead', 'LEAD']` — leads `['crm', 'CCrmDocumentDeal', 'DEAL']` — deals `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE']` — estimates `['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE']` — invoices `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_XXX']` — SPAs, where XXX is the identifier of the SPA
FILTER `object`	Object with rules for restricting the Automation Rule by document type and edition. Can contain keys: `INCLUDE` — array of rules where the Automation Rule will be displayed `EXCLUDE` — array of rules where the Automation Rule will be hidden Each rule in the array can be a string or an array of document types in full or partial form. To restrict the Automation Rule by Bitrix24 edition, specify: `b24` — for cloud `box` — for on-premise Examples: Exclude the Automation Rule for on-premise Bitrix24 `'FILTER': { EXCLUDE: [ 'box' ] }` Display the Automation Rule only for deals and leads in CRM `'FILTER': { INCLUDE: [ ['crm', 'CCrmDocumentDeal'], ['crm', 'CCrmDocumentLead'] ] }`
USE_PLACEMENT `boolean`	Allows opening additional settings for the Automation Rule in the application slider. Possible values: `Y` — yes `N` — no
PLACEMENT_HANDLER `string`	URL of the placement handler on the application side. It is validated the same way as `HANDLER`. To enable the placement, pass the URL together with `USE_PLACEMENT: 'Y'`. The `USE_PLACEMENT: 'N'` value removes the handler registration, so you need to pass the URL again when you re-enable the placement

PROPERTY Object

Name `type`	Description
Name* `string` \| `object`	Name of the parameter. Without it, the method returns the `Empty property NAME` error
Description `string` \| `object`	Description of the parameter
Type `string`	Type of the parameter. Basic values: `bool` — yes or no `date` — date `datetime` — date and time `double` — number `file` — file `int` — integer `select` — list `string` — string `text` — text `user` — user
Options `object`	Options for a list-type parameter, `Type: 'select'`. The key is the option value, and the value is its title: `{ 'value1': 'title1', 'value2': 'title2', 'value3': 'title3', 'value4': 'title4' }`
Required `boolean`	Requirement of the parameter. Possible values: `Y` — yes `N` — no
Multiple `boolean`	Multiplicity of the parameter. Possible values: `Y` — yes `N` — no
Default `any`	Default value of the parameter. For `Type = 'select'`, specify the key from `Options`. For a parameter in `RETURN_PROPERTIES`, this value is kept if bizproc.event.send does not pass the key of this parameter or passes `null`

Examples of Objects

Below are examples of PROPERTY objects for different parameter types.

select

'docType': {
            'Name': {
                'de': 'Dokumenttyp',
                'en': 'Document type'
            },
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'pdf',
            'Type': 'select',
            'Options': {
                'pdf': 'PDF',
                'docx': 'DOCX'
            }
        }

bool

'saveDoc': {
            'Name': {
                'de': 'Dokument speichern',
                'en': 'Save document'
            },
            'Description': {
                'de': 'Einen fortlaufenden Nummer zuweisen',
                'en': 'Assign a sequential number'
            },
            'Type': 'bool',
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'Y'
        }

file

'attachment': {
            'Name': {
                'de': 'Datei',
                'en': 'File'
            },
            'Description': {
                'de': 'Datei zum Senden',
                'en': 'File to send'
            },
            'Type': 'file',
            'Required': 'N',
            'Multiple': 'Y'
        }

string

'Parameters': {
            'Name': {
                'de': 'Vorlagenparameter',
                'en': 'Template\'s parameters'
            },
            'Description': {
                'de': 'ParamID={=ParamValue}',
                'en': 'ParamID={=ParamValue}'
            },
            'Type': 'string',
            'Required': 'N',
            'Multiple': 'Y'
        }

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"test_robot","FIELDS":{"NAME":"Send message to author","USE_SUBSCRIPTION":"N","FILTER":{"INCLUDE":[["crm","CCrmDocumentDeal"]]}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.robot.update

try
        {
            const response = await $b24.actions.v2.call.make({
                method: 'bizproc.robot.update',
                params: {
                    'CODE': 'test_robot',
                    'FIELDS': {
                        'NAME': 'Send message to author',
                        'USE_SUBSCRIPTION': 'N',
                        'FILTER': {
                            INCLUDE: [
                                ['crm', 'CCrmDocumentDeal']
                            ]
                        }
                    }
                }
            });
        
            if (!response.isSuccess)
                console.error(response.getErrorMessages().join('; '));
            else
                console.log('Success:', response.getData().result);
        }
        catch( error )
        {
            alert("Error: " + error);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.bizproc.robot.update(
                code="test_robot",
                fields={
                    "NAME": "Send a message to the author",
                    "USE_SUBSCRIPTION": "N",
                    "FILTER": {
                        "INCLUDE": [
                            [
                                "crm",
                                "CCrmDocumentDeal",
                            ],
                        ],
                    },
                },
            ).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 {
            $result = $serviceBuilder
                ->getBizProcScope()
                ->robot()
                ->update(
                    'robot_code',
                    'https://example.com/handler',
                    1,
                    ['en' => 'Localized Name'],
                    true,
                    ['property1' => ['Name' => 'Parameter', 'Type' => 'string']],
                    false,
                    ['outputString' => ['Name' => 'Result', 'Type' => 'string']]
                );
        
            // Process the result
            if ($result->isSuccess()) {
                print_r($result->getCoreResponse()->getResponseData()->getResult());
            } else {
                print("Update failed.");
            }
        } catch (Throwable $e) {
            print("An error occurred: " . $e->getMessage());
        }

BX24.callMethod(
            'bizproc.robot.update',
            {
                'CODE': 'test_robot',
                'FIELDS': {
                    'NAME': 'Send message to author',
                    'USE_SUBSCRIPTION': 'N',
                    'FILTER': {
                        INCLUDE: [
                            ['crm', 'CCrmDocumentDeal']
                        ]
                    }
                },
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.robot.update',
            [
                'CODE' => 'test_robot',
                'FIELDS' => [
                    'NAME' => 'Send message to author',
                    'USE_SUBSCRIPTION' => 'N',
                    'FILTER' => [
                        'INCLUDE' => [
                            ['crm', 'CCrmDocumentDeal']
                        ]
                    ]
                ]
            ]
        );
        
        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.robot.update", b24.Params{
        	"CODE": "test_robot",
        	"FIELDS": b24.Params{
        		"NAME":             "Send message to author",
        		"USE_SUBSCRIPTION": "N",
        		"FILTER": b24.Params{
        			"INCLUDE": []any{
        				[]string{"crm", "CCrmDocumentDeal"},
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("bizproc.robot.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1738149954.2918739,
                "finish": 1738149954.4590819,
                "duration": 0.16720795631408691,
                "processing": 0.017282962799072266,
                "date_start": "2025-01-29T14:25:54+01:00",
                "date_finish": "2025-01-29T14:25:54+01:00",
                "operating_reset_at": 1738150554,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the Automation Rule was successfully updated
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
            "error_description": "Wrong properties array!"
        }

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
`403`	`ACCESS_DENIED`	Access denied! Application context required	Application context is required
`403`	`ACCESS_DENIED`	Access denied!	The method was called by a non-administrator
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty activity code!	Automation Rule code is not specified
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity code!	Invalid Automation Rule code
`400`	`ERROR_ACTIVITY_NOT_FOUND`	Activity or Robot not found!	Automation Rule not found
`400`	`ERROR_UNSUPPORTED_PROTOCOL`	Unsupported handler protocol	Invalid handler protocol http, https
`400`	`ERROR_WRONG_HANDLER_URL`	Wrong handler URL	Invalid handler URL
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong properties array!	The `PROPERTIES` or `RETURN_PROPERTIES` parameters are specified incorrectly
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong property key (<key>)!	Invalid property identifier
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty property NAME (<key>)!	Property name not specified
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity FILTER!	Invalid filter
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity DOCUMENT_TYPE!	Invalid `DOCUMENT_TYPE`
`400`	`ERROR_ACTIVITY_VALIDATION_FAILURE`	No fields to update	No fields to update
`400`	`ERROR_CORE`	Unable to set placement handler: Handler already binded	The URL is already used by the settings handler of another Automation Rule or workflow action of this application: each `CODE` must have its own URL
`400`	`ERROR_CORE`	Unable to set placement handler: <error text>	Failed to retain the placement handler

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?

Get a List of Automation Rules

Update Fields of the Automation Rule bizproc.robot.update

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

PROPERTY ObjectPROPERTY Object

Examples of ObjectsExamples of Objects

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