Create a Template for Recurring Deal crm.deal.recurring.add

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

Who can execute the method: a user with "add" and "edit" permissions for deals

The method crm.deal.recurring.add creates a template for a recurring deal based on an existing deal.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object format:

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

where:

  • field_n — name of the setting field
  • value_n — value of the setting field

The list of available fields is described below

Parameter fields

Name
type

Description

DEAL_ID
integer

Identifier of the deal based on which the recurring deal template is created.

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

ACTIVE
char

Activity flag of the setting. Possible values:

  • Y — active
  • N — inactive

CATEGORY_ID
char

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 — limit by date (LIMIT_DATE)
T — limit by quantity (LIMIT_REPEAT)

If any other value is passed, it will be converted to N

LIMIT_REPEAT
integer

Maximum number of deals that can be created from the template. Used when IS_LIMIT = T

LIMIT_DATE
date

End date for generating deals from the template in the format YYYY-MM-DD. Used when IS_LIMIT = D

START_DATE
date

Start date for calculating the next run in the format YYYY-MM-DD

PARAMS
object

Frequency parameters (detailed description)

Parameter PARAMS

Name
type

Description

MODE
string

Repetition mode:
single — single
multiple — multiple

MULTIPLE_TYPE
string

Type of period for MODE = multiple:
day, week, month, year

MULTIPLE_INTERVAL
integer

Repetition interval for MODE = multiple

SINGLE_BEFORE_START_DATE_TYPE
string

Offset type for MODE = single:
day, week, month, year

SINGLE_BEFORE_START_DATE_VALUE
integer

Offset value for MODE = single

OFFSET_BEGINDATE_TYPE
string

Offset type for the start date of the created deal:
day, week, month, year

OFFSET_BEGINDATE_VALUE
integer

Offset value for the start date of the created deal

OFFSET_CLOSEDATE_TYPE
string

Offset type for the end date of the created deal:
day, week, month, year

OFFSET_CLOSEDATE_VALUE
integer

Offset value for the end date of the created deal

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","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.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","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.add
        
// 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
        
        const current = new Date()
        const nextMonth = new Date()
        const nextYear = new Date()
        nextMonth.setMonth(current.getMonth() + 1)
        nextYear.setFullYear(current.getFullYear() + 1)
        
        const padDatePart = (part: number) => (part >= 10 ? part.toString() : `0${part}`)
        const date2str = (d: Date) =>
          `${d.getFullYear()}-${padDatePart(1 + d.getMonth())}-${padDatePart(d.getDate())}`
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.deal.recurring.add',
            params: {
              fields: {
                DEAL_ID: 45,
                CATEGORY_ID: '1',
                IS_LIMIT: 'D',
                LIMIT_DATE: date2str(nextYear),
                START_DATE: date2str(nextMonth),
                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 deal settings id:', 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 addRecurringDeal() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const current = new Date()
              const nextMonth = new Date()
              const nextYear = new Date()
              nextMonth.setMonth(current.getMonth() + 1)
              nextYear.setFullYear(current.getFullYear() + 1)
        
              const padDatePart = (part) => (part >= 10 ? part.toString() : `0${part}`)
              const date2str = (d) =>
                `${d.getFullYear()}-${padDatePart(1 + d.getMonth())}-${padDatePart(d.getDate())}`
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.deal.recurring.add',
                params: {
                  fields: {
                    DEAL_ID: 45,
                    CATEGORY_ID: '1',
                    IS_LIMIT: 'D',
                    LIMIT_DATE: date2str(nextYear),
                    START_DATE: date2str(nextMonth),
                    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 deal settings id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addRecurringDeal)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.recurring.add(
                fields={
                    "TITLE": "Monthly Retainer Renewal",
                    "CATEGORY_ID": 0,
                    "STAGE_ID": "NEW",
                    "IS_ACTIVE": "Y",
                    "CURRENCY_ID": "USD",
                    "OPPORTUNITY": 5000,
                },
            ).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 {
            $current = new DateTime();
            $nextMonth = (clone $current)->modify('+1 month');
            $nextYear = (clone $current)->modify('+1 year');
        
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.add',
                    [
                        'fields' => [
                            'DEAL_ID'     => 45,
                            'CATEGORY_ID' => '1',
                            'IS_LIMIT'    => 'D',
                            'LIMIT_DATE'  => $nextYear->format('Y-m-d'),
                            'START_DATE'  => $nextMonth->format('Y-m-d'),
                            '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: Recurring deal setting ID - ' . $result->data();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding recurring deal settings: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.recurring.add',
            {
                fields: {
                    DEAL_ID: 45,
                    CATEGORY_ID: '1',
                    IS_LIMIT: 'D',
                    LIMIT_DATE: '2027-03-04',
                    START_DATE: '2026-04-04',
                    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('Recurring deal setting ID:', result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.add',
            [
                'fields' => [
                    'DEAL_ID' => 45,
                    'CATEGORY_ID' => '1',
                    'IS_LIMIT' => 'D',
                    'LIMIT_DATE' => '2027-03-04',
                    'START_DATE' => '2026-04-04',
                    '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.add", b24.Params{
        	"fields": b24.Params{
        		"DEAL_ID":     45,
        		"CATEGORY_ID": "1",
        		"IS_LIMIT":    "D",
        		"LIMIT_DATE":  "2027-03-04",
        		"START_DATE":  "2026-04-04",
        		"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.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)
        

Response Handling

HTTP Status: 200

{
            "result": 15,
            "time": {
                "start": 1772664456,
                "finish": 1772664457.379632,
                "duration": 1.3796319961547852,
                "processing": 1,
                "date_start": "2026-03-05T01:47:36+01:00",
                "date_finish": "2026-03-05T01:47:37+01:00",
                "operating_reset_at": 1772665056,
                "operating": 0.7352650165557861
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created recurring deal template setting

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Deal already has recurring settings."
        }
        

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

Parameter 'fields' must be array

The fields parameter is not provided or is not in object format

Parameter 'params' must be array

The params parameter is not provided in object format

Deal id is empty

An empty or incorrect value is passed in fields.DEAL_ID

Access denied

Insufficient permissions to modify the original deal or create deals

Deal already has recurring settings

A recurring setting already exists for the provided 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

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