Update Business Process Template bizproc.workflow.template.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

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)

Python

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.bizproc.workflow.template.update(
                bitrix_id=525,
                fields={
                    "NAME": "Display the time",
                    "DESCRIPTION": "The template displays a message with the local and server time",
                    "AUTO_EXECUTE": 0,
                },
            ).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.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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "bizproc.workflow.template.update", b24.Params{
        	"ID": 525,
        	"FIELDS": b24.Params{
        		"NAME":         "Display Time",
        		"DESCRIPTION":  "Template shows a message with local and server time",
        		"AUTO_EXECUTE": 0,
        	},
        })
        if err != nil {
        	return fmt.Errorf("bizproc.workflow.template.update: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)

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

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

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