метод REST scope: crm

crm.deal.recurring.add

Создать шаблон регулярной сделки

Кто может выполнять: пользователь с правами «добавление» и «изменение» сделок

Описание

Метод crm.deal.recurring.add создает шаблон регулярной сделки на основе сделки.

Параметры

fields object необязательный

Объект формата:

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

где:
- field_n — название поля настройки
- value_n — значение поля настройки

Список доступных полей описан ниже

Параметр fields

DEAL_ID integer необязательный

Идентификатор сделки, на основе которой создается шаблон регулярной сделки.

Идентификатор сделки можно получить с помощью методов crm.deal.list или crm.deal.add

ACTIVE char необязательный

Флаг активности настройки. Возможные значения:
- Y — активна
- N — неактивна

CATEGORY_ID char необязательный

id воронки для новых сделок, создаваемых из шаблона.

Список доступных воронок можно узнать с помощью метода crm.category.list, передав entityTypeId = 2

IS_LIMIT char необязательный

Ограничение по созданию новых сделок:
N — без ограничений
D — ограничение по дате (LIMIT_DATE)
T — ограничение по количеству (LIMIT_REPEAT)

Если передано любое другое значение, оно будет приведено к N

LIMIT_REPEAT integer необязательный

Максимальное количество сделок, которые можно создать из шаблона. Используется при IS_LIMIT = T

LIMIT_DATE date необязательный

Дата окончания генерации сделок из шаблона в формате YYYY-MM-DD. Используется при IS_LIMIT = D

START_DATE date необязательный

Дата начала расчета следующего запуска в формате YYYY-MM-DD

PARAMS object необязательный

Параметры периодичности (подробное описание)

Параметр PARAMS

MODE string необязательный

Режим повторения:
single — одиночный
multiple — множественный

MULTIPLE_TYPE string необязательный

Тип периода для MODE = multiple:
day, week, month, year

MULTIPLE_INTERVAL integer необязательный

Интервал повторения для MODE = multiple

SINGLE_BEFORE_START_DATE_TYPE string необязательный

Тип смещения для MODE = single:
day, week, month, year

SINGLE_BEFORE_START_DATE_VALUE integer необязательный

Значение смещения для MODE = single

OFFSET_BEGINDATE_TYPE string необязательный

Тип смещения даты начала создаваемой сделки:
day, week, month, year

OFFSET_BEGINDATE_VALUE integer необязательный

Значение смещения даты начала создаваемой сделки

OFFSET_CLOSEDATE_TYPE string необязательный

Тип смещения даты завершения создаваемой сделки:
day, week, month, year

OFFSET_CLOSEDATE_VALUE integer необязательный

Значение смещения даты завершения создаваемой сделки

Примеры запроса

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

Ответ

HTTP-статус: 200

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

Возвращаемые данные

result integer

Идентификатор созданной настройки шаблона регулярной сделки

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "Deal already have had recurring settings."
}
Код Описание Значение
Parameter 'fields' must be array Параметр fields не передан или передан не в формате объекта
Parameter 'params' must be array Параметр params передан не в формате объекта
Deal id is empty В fields.DEAL_ID передано пустое или некорректное значение
Access denied Недостаточно прав для изменения исходной сделки или создания сделок
Deal already have had recurring settings Для переданной сделки уже существует настройка регулярности

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.