Update Business Process Template bizproc.workflow.template.update

Scope: bizproc

Who can execute the method: administrator

This method updates a business process template.

It allows you to update templates that were created using the bizproc.workflow.template.add method. These templates are tied to the application and can only be updated in the context of the same application that created them.

Method Parameters

Required parameters are marked with *

Name
type

Description

ID*
string

Identifier of the template to be updated

FIELDS*
object

Object with fields of the business process template.

You can update the fields: NAME, DESCRIPTION, TEMPLATE_DATA, AUTO_EXECUTE. Attempting to update other fields of the template will not result in errors, but those fields will not be updated

FIELDS Parameter

Name `type`	Description
NAME `string`	Name of the template
DESCRIPTION `string`	Description of the template
TEMPLATE_DATA `file`	Content of the file with the business process template in `.bpt` format. More details on how to transfer files can be found in the article How to Update and Delete Files
AUTO_EXECUTE `integer`	Auto-execution settings for the template. Can have the following values: `0` — no auto-execution `1` — execute on creation `2` — execute on modification `3` — execute on creation and modification Default is `0`

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 '{"ID":525,"FIELDS":{"NAME":"Display Time","DESCRIPTION":"Template shows a message with local and server time","AUTO_EXECUTE":0},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.workflow.template.update

try
        {
        	const response = await $b24.callMethod(
        		'bizproc.workflow.template.update',
        		{
        			ID: 525,
        			FIELDS: {
        				NAME: 'Display Time',
        				DESCRIPTION: 'Template shows a message with local and server time',
        				AUTO_EXECUTE: 0,
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.workflow.template.update',
                    [
                        'ID'     => 525,
                        'FIELDS' => [
                            'NAME'        => 'Display Time',
                            'DESCRIPTION' => 'Template shows a message with local and server time',
                            'AUTO_EXECUTE' => 0,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating workflow template: ' . $e->getMessage();
        }

BX24.callMethod(
            'bizproc.workflow.template.update',
            {
                ID: 525,
                FIELDS: {
                    NAME: 'Display Time',
                    DESCRIPTION: 'Template shows a message with local and server time',
                    AUTO_EXECUTE: 0,
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.template.update',
            [
                'ID' => 525,
                'FIELDS' => [
                    'NAME' => 'Display Time',
                    'DESCRIPTION' => 'Template shows a message with local and server time',
                    'AUTO_EXECUTE' => 0
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": 525,
            "time": {
                "start": 1737534421.172673,
                "finish": 1737534421.209758,
                "duration": 0.037085056304931641,
                "processing": 0.010869026184082031,
                "date_start": "2025-01-22T11:27:01+01:00",
                "date_finish": "2025-01-22T11:27:01+01:00",
                "operating_reset_at": 1737535021,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Identifier of the updated business process template
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "ERROR_TEMPLATE_NOT_OWNER",
            "error_description": "You can update ONLY templates created by current application",
        }

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	Access token not from the application
`ACCESS_DENIED`	Access denied!	Method was not executed by an administrator
`ERROR_TEMPLATE_VALIDATION_FAILURE`	No fields to update.	No fields specified for update
`ERROR_TEMPLATE_NOT_FOUND`	Workflow template not found.	Template with the specified `ID` not found
`ERROR_TEMPLATE_NOT_OWNER`	You can update ONLY templates created by current application	This template cannot be edited through this application
`ERROR_TEMPLATE_VALIDATION_FAILURE`	Empty template name!	Empty template name specified
`ERROR_TEMPLATE_VALIDATION_FAILURE`	Incorrect field AUTO_EXECUTE!	Invalid auto-execution code specified
`ERROR_TEMPLATE_VALIDATION_FAILURE`	Incorrect field TEMPLATE_DATA!	Invalid template data specified

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 Template

Get List of Templates

Update Business Process Template bizproc.workflow.template.update

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

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