Update Action bizproc.activity.update

Scope: bizproc

Who can execute the method: administrator

This method updates a business process action added by the application.

It works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Internal identifier of the action
FIELDS* `object`	Object with fields of the business process action

Parameter FIELDS

Name `type`	Description
HANDLER* `string`	URL to which the action will send data via the Bitrix24 queue server. The link must have the same domain where the application is installed
AUTH_USER_ID `integer`	Identifier of the user whose token will be passed to the application
USE_SUBSCRIPTION `boolean`	Should the action wait for a response from the application. Possible values: `Y` — yes `N` — no
NAME* `string` \| `object`	Name of the action. Can be a string or an associative array of localized strings like: `'NAME': { 'de': 'Aktionsname', 'en': 'action name', ... },`
DESCRIPTION `string` \| `object`	Description of the action. Can be a string or an associative array of localized strings like: `'DESCRIPTION': { 'de': 'Aktionsbeschreibung', 'en': 'action description', ... },`
PROPERTIES `object`	Object with action parameters. Contains objects, each describing a parameter of the action. 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 action. Contains objects, each describing a parameter of the action. This parameter controls whether the action can wait for a response from the application and work with the data that will come in the response. 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', 'CCrmDocumentContact', 'CONTACT']` — contacts `['crm', 'CCrmDocumentCompany', 'COMPANY']` — companies `['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 Lists Module `['lists', 'BizprocDocument', 'iblock_XXX']` — processes in the news feed, where XXX is the identifier of the information block `['lists', 'Bitrix\Lists\BizprocDocumentLists', 'iblock_XXX']` — lists in groups, where XXX is the identifier of the information block Drive Module `['disk', 'Bitrix\Disk\BizProcDocument', 'STORAGE_XXX']`, where XXX is the storage identifier
FILTER `object`	Object with rules to limit the action by document type and edition. May contain keys: `INCLUDE` — array of rules where the action will be displayed `EXCLUDE` — array of rules where the action will be hidden Each rule in the array can be a string or an array of document types in full or partial form. To limit the action by Bitrix24 edition, specify: `b24` — for cloud `box` — for on-premise Examples: Exclude action for on-premise Bitrix24 `FILTER: { EXCLUDE: [ 'box' ] }` Display action only for the Lists module `FILTER: { INCLUDE: [ ['lists'] ] }` Display action only for the Lists module and deals from CRM `FILTER: { INCLUDE: [ ['lists'], ['crm', 'CCrmDocumentDeal'] ] }`
USE_PLACEMENT `boolean`	Allows opening additional settings of the action in the application slider. Possible values: `Y` — yes `N` — no
PLACEMENT_HANDLER* `string`	URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'`

Object PROPERTY

Name `type`	Description
Name `string` \| `object`	Name of the parameter
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 `int` — integer `select` — list `string` — string `text` — text `user` — user
Options `array`	Array of values for the parameter of type list `'TYPE': select'` like: `[ '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

Example Objects

// example for select type
        'docType': {
            'Name': {
                'de': 'Dokumenttyp',
                'en': 'Document type'
            },
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'PDF',
            'Type': 'select',
            'Options': {
                'pdf': 'PDF',
                'docx': 'DOCX'
            }
        }
        
        // example for bool type
        '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'
        }
        
        // example for string type
        '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)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"action_test_code","FIELDS":{"AUTH_USER_ID":1,"USE_SUBSCRIPTION":"N","FILTER":{"INCLUDE":[["lists"],["crm","CCrmDocumentDeal"]]}}, "auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.activity.update

try
        {
        	const response = await $b24.callMethod(
        		'bizproc.activity.update',
        		{
        			'CODE': 'action_test_code',
        			'FIELDS': {
        				'AUTH_USER_ID': 1,
        				'USE_SUBSCRIPTION': 'N',
        				'FILTER': {
        					'INCLUDE': [
        						['lists'],
        						['crm', 'CCrmDocumentDeal']
        					]
        				}
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	alert("Success: " + result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }

try {
            $result = $serviceBuilder
                ->getBizProcScope()
                ->activity()
                ->update(
                    'activity_code',
                    'https://example.com/handler',
                    1,
                    ['en' => 'Activity Name', 'de' => 'Aktivitätsname'],
                    ['en' => 'Activity Description', 'de' => 'Aktivitätsbeschreibung'],
                    true,
                    ['param1' => 'value1'],
                    false,
                    ['returnParam1' => 'value1'],
                    null,
                    null
                );
        
            if ($result->isSuccess()) {
                print($result->getCoreResponse()->getResponseData()->getResult()[0]);
            } else {
                print('Update failed.');
            }
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

BX24.callMethod(
            'bizproc.activity.update',
            {
                'CODE': 'action_test_code',
                'FIELDS': {
                    'AUTH_USER_ID': 1,
                    'USE_SUBSCRIPTION': 'N',
                    'FILTER': {
                        'INCLUDE': [
                            ['lists'],
                            ['crm', 'CCrmDocumentDeal']
                        ]
                    }
                },
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.activity.update',
            [
                'CODE' => 'action_test_code',
                'FIELDS' => [
                    'AUTH_USER_ID' => 1,
                    'USE_SUBSCRIPTION' => 'N',
                    'FILTER' => [
                        'INCLUDE' => [
                            ['lists'],
                            ['crm', 'CCrmDocumentDeal']
                        ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

Code	Error Message	Description
`ACCESS_DENIED`	Application context required	Application context is required
`ACCESS_DENIED`	Access denied!	Method executed by a non-administrator
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty activity code!	Action code not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity code!	Invalid action code
`ERROR_ACTIVITY_NOT_FOUND`	Activity or Robot not found!	Action or robot not found
`ERROR_UNSUPPORTED_PROTOCOL`	Unsupported handler protocol	Invalid handler protocol http, https
`ERROR_WRONG_HANDLER_URL`	Wrong handler URL	Invalid handler URL
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong properties array!	Incorrectly filled parameters `PROPERTIES` or `RETURN_PROPERTIES`
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong property key !	Invalid property identifier
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty property NAME !	Property name not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity FILTER!	Invalid filter
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity DOCUMENT_TYPE!	Invalid `DOCUMENT_TYPE`
`ERROR_ACTIVITY_VALIDATION_FAILURE`	No fields to update	No fields to update

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

Add New Action

Get List of Application Actions

Update Action bizproc.activity.update

Method ParametersMethod Parameters

Parameter FIELDSParameter FIELDS

Object PROPERTYObject PROPERTY

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