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

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

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)

JS (TS)

JS (UMD)

Python

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'crm.deal.recurring.update',
            params: {
              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,
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Recurring setting updated:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateRecurringDeal() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.deal.recurring.update',
                params: {
                  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,
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Recurring setting updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateRecurringDeal)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.recurring.update(
                bitrix_id=77,
                fields={
                    "TITLE": "Monthly Retainer Renewal - Updated",
                    "IS_ACTIVE": "Y",
                    "OPPORTUNITY": 6500,
                    "STAGE_ID": "PREPARATION",
                },
            ).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(
                    '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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.deal.recurring.update", b24.Params{
        	"id": 15,
        	"fields": b24.Params{
        		"ACTIVE":      "Y",
        		"CATEGORY_ID": "2",
        		"IS_LIMIT":    "D",
        		"LIMIT_DATE":  "2027-03-05",
        		"START_DATE":  "2026-04-05",
        		"PARAMS": b24.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,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.deal.recurring.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": 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 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	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: 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	The REST API is available only on commercial plans. 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?

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