Update the Recurring Deal Template Settings `crm.deal.recurring.update`

Scope: crm

Who can execute the method: a user with "read" and "modify" access permissions for deals

The method crm.deal.recurring.update updates an existing recurring deal template setting.

Method Parameters

Required parameters are marked with *

Name
type

Description

id^*
integer

The identifier of the recurring deal template setting.

The identifier can be obtained using the methods crm.deal.recurring.list or crm.deal.recurring.add

fields
object

An object in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — the name of the setting field
value_n — the new value for the setting field

The list of available fields is described below

Fields Parameter

Name `type`	Description
ACTIVE `char`	The active flag for the setting. Possible values: `Y` — active `N` — inactive
CATEGORY_ID `char`	The ID of the funnel for new deals created from the template. The list of available funnels can be obtained using the method crm.category.list by passing `entityTypeId = 2`
IS_LIMIT `char`	Limit on creating new deals: `N` — no limits `D` — date limit (`LIMIT_DATE`) `T` — quantity limit (`LIMIT_REPEAT`)
LIMIT_REPEAT `integer`	The maximum number of deals that can be created from the template. Used when `IS_LIMIT = T`
LIMIT_DATE `date`	The end date for generating deals from the template in the format `YYYY-MM-DD`. Used when `IS_LIMIT = D`
START_DATE `date`	The start date for calculating the next run in the format `YYYY-MM-DD`
PARAMS `object`	Recurrence parameters (detailed description)

PARAMS Parameter

Name `type`	Description
MODE `string`	The recurrence mode: `single` — single `multiple` — multiple
MULTIPLE_TYPE `string`	The period type for `MODE = multiple`: `day` `week` `month` `year`
MULTIPLE_INTERVAL `integer`	The recurrence interval for `MODE = multiple`
SINGLE_BEFORE_START_DATE_TYPE `string`	The offset type for `MODE = single`: `day` `week` `month` `year`
SINGLE_BEFORE_START_DATE_VALUE `integer`	The offset value for `MODE = single`
OFFSET_BEGINDATE_TYPE `string`	The offset type for the start date of the created deal: `day` `week` `month` `year`
OFFSET_BEGINDATE_VALUE `integer`	The offset value for the start date of the created deal
OFFSET_CLOSEDATE_TYPE `string`	The offset type for the completion date of the created deal: `day` `week` `month` `year`
OFFSET_CLOSEDATE_VALUE `integer`	The offset value for the completion date of the created deal

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"fields":{"ACTIVE":"Y","CATEGORY_ID":"2","IS_LIMIT":"D","LIMIT_DATE":"2027-03-05","START_DATE":"2026-04-05","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"fields":{"ACTIVE":"Y","CATEGORY_ID":"2","IS_LIMIT":"D","LIMIT_DATE":"2027-03-05","START_DATE":"2026-04-05","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.recurring.update

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.recurring.update',
        		{
        			id: 15,
        			fields: {
        				ACTIVE: 'Y',
        				CATEGORY_ID: '2',
        				IS_LIMIT: 'D',
        				LIMIT_DATE: '2027-03-05',
        				START_DATE: '2026-04-05',
        				PARAMS: {
        					MODE: 'multiple',
        					MULTIPLE_TYPE: 'month',
        					MULTIPLE_INTERVAL: 1,
        					OFFSET_BEGINDATE_TYPE: 'day',
        					OFFSET_BEGINDATE_VALUE: 1,
        					OFFSET_CLOSEDATE_TYPE: 'month',
        					OFFSET_CLOSEDATE_VALUE: 2,
        				}
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info('Template updated:', result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.update',
                    [
                        'id' => 15,
                        'fields' => [
                            'ACTIVE'      => 'Y',
                            'CATEGORY_ID' => '2',
                            'IS_LIMIT'    => 'D',
                            'LIMIT_DATE'  => '2027-03-05',
                            'START_DATE'  => '2026-04-05',
                            'PARAMS'      => [
                                'MODE'                   => 'multiple',
                                'MULTIPLE_TYPE'          => 'month',
                                'MULTIPLE_INTERVAL'      => 1,
                                'OFFSET_BEGINDATE_TYPE'  => 'day',
                                'OFFSET_BEGINDATE_VALUE' => 1,
                                'OFFSET_CLOSEDATE_TYPE'  => 'month',
                                'OFFSET_CLOSEDATE_VALUE' => 2,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . var_export($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating recurring deal settings: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.recurring.update',
            {
                id: 15,
                fields: {
                    ACTIVE: 'Y',
                    CATEGORY_ID: '2',
                    IS_LIMIT: 'D',
                    LIMIT_DATE: '2027-03-05',
                    START_DATE: '2026-04-05',
                    PARAMS: {
                        MODE: 'multiple',
                        MULTIPLE_TYPE: 'month',
                        MULTIPLE_INTERVAL: 1,
                        OFFSET_BEGINDATE_TYPE: 'day',
                        OFFSET_BEGINDATE_VALUE: 1,
                        OFFSET_CLOSEDATE_TYPE: 'month',
                        OFFSET_CLOSEDATE_VALUE: 2
                    }
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.info('Template updated:', result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.update',
            [
                'id' => 15,
                'fields' => [
                    'ACTIVE' => 'Y',
                    'CATEGORY_ID' => '2',
                    'IS_LIMIT' => 'D',
                    'LIMIT_DATE' => '2027-03-05',
                    'START_DATE' => '2026-04-05',
                    'PARAMS' => [
                        'MODE' => 'multiple',
                        'MULTIPLE_TYPE' => 'month',
                        'MULTIPLE_INTERVAL' => 1,
                        'OFFSET_BEGINDATE_TYPE' => 'day',
                        'OFFSET_BEGINDATE_VALUE' => 1,
                        'OFFSET_CLOSEDATE_TYPE' => 'month',
                        'OFFSET_CLOSEDATE_VALUE' => 2
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1772731825,
                "finish": 1772731825.579511,
                "duration": 0.5795109272003174,
                "processing": 0,
                "date_start": "2026-03-05T20:30:25+02:00",
                "date_finish": "2026-03-05T20:30:25+02:00",
                "operating_reset_at": 1772732425,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	The root element of the response. Returns `true` for a successful update
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Recurring deal is not found."
        }

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	Description
`id is not defined or invalid`	The parameter `id` has been passed with an empty or invalid value
`Parameter 'fields' must be array`	The parameter `fields` is missing or not in object format
`Recurring is not allowed`	Recurring deals are not available in Bitrix24
`Recurring deal is not found`	The recurring deal template was not found
`Access denied`	Insufficient permissions to read or modify the associated deal

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

Create a New Deal from a Template

Retrieve Template Settings for the Regular Deal by Id

Update the Recurring Deal Template Settings crm.deal.recurring.update

Method ParametersMethod Parameters

Fields ParameterFields Parameter

PARAMS ParameterPARAMS 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