Create a Template for Recurring Deal crm.deal.recurring.add
Scope:
crmWho 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 |
Description |
|
fields* |
Object format:
where:
The list of available fields is described below |
Parameter fields
|
Name |
Description |
|
DEAL_ID |
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 |
Activity flag of the setting. Possible values:
|
|
CATEGORY_ID |
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 |
|
IS_LIMIT |
Limit on creating new deals: If any other value is passed, it will be converted to |
|
LIMIT_REPEAT |
Maximum number of deals that can be created from the template. Used when |
|
LIMIT_DATE |
End date for generating deals from the template in the format |
|
START_DATE |
Start date for calculating the next run in the format |
|
PARAMS |
Frequency parameters (detailed description) |
Parameter PARAMS
|
Name |
Description |
|
MODE |
Repetition mode: |
|
MULTIPLE_TYPE |
Type of period for |
|
MULTIPLE_INTERVAL |
Repetition interval for |
|
SINGLE_BEFORE_START_DATE_TYPE |
Offset type for |
|
SINGLE_BEFORE_START_DATE_VALUE |
Offset value for |
|
OFFSET_BEGINDATE_TYPE |
Offset type for the start date of the created deal: |
|
OFFSET_BEGINDATE_VALUE |
Offset value for the start date of the created deal |
|
OFFSET_CLOSEDATE_TYPE |
Offset type for the end date of the created deal: |
|
OFFSET_CLOSEDATE_VALUE |
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
try
{
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.callMethod(
'crm.deal.recurring.add',
{
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,
}
}
}
);
const result = response.getData().result;
console.info('Recurring deal setting ID:', result);
}
catch(error)
{
console.error('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>';
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 |
Description |
|
result |
Identifier of the created recurring deal template setting |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Deal already has recurring settings."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
The |
|
|
The |
|
|
An empty or incorrect value is passed in |
|
|
Insufficient permissions to modify the original deal or create deals |
|
|
A recurring setting already exists for the provided deal |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields
- Get Recurring Deal Template Settings by ID crm.deal.recurring.get
- Get a List of Recurring Deal Template Settings crm.deal.recurring.list
- Update the Recurring Deal Template Settings `crm.deal.recurring.update`
- Delete the Recurring Deal Template Setting crm.deal.recurring.delete
- Create a New Deal from the Template crm.deal.recurring.expose