## Создать настройку `POST /v1/recurring-deals` Создаёт настройку автоматического повторения сделки. ## Поля запроса (body) Поля передаются в корне JSON. | Поле | Тип | Обяз. | Описание | |---|---|---|---| | `dealId` | number / string | да | ID исходной сделки, положительное целое число. Числовая строка также принимается. Источник — [список сделок](/docs/entities/deals/list) | | `active` | boolean / string / null | нет | Активность автоматического повторения. Строковые формы: `"true"` / `"false"`, `"yes"` / `"no"`, `"y"` / `"n"`, `"1"` / `"0"` | | `startDate` | date / null | нет | Дата начала расписания, например `2027-01-01` | | `categoryId` | number / string / null | нет | ID воронки создаваемых сделок. Числовая строка также принимается. Источник — [список воронок сделок](/docs/entities/deal-categories/list) | | `isLimit` | string | нет | Ограничение повторов: `N` — без ограничений, `T` — по числу `limitRepeat`, `D` — по дате `limitDate` | | `limitRepeat` | number / string / null | нет | Целое число повторов для режима `T`. Числовая строка также принимается | | `limitDate` | date / null | нет | Последняя допустимая дата для режима `D` | | `params` | object | нет | Полный объект расписания. Параметры перечислены ниже | | `params.mode` | string / number / null | нет | Режим: `single` или `multiple`. Принимаются также числовые коды `1` и `2` | | `params.singleBeforeStartDateValue` | number / string / null | нет | Целое неотрицательное смещение до даты начала. Числовая строка также принимается | | `params.singleBeforeStartDateType` | string / number / null | нет | Единица смещения: `day`, `week`, `month` или `year`. Принимаются также числовые коды единиц | | `params.multipleType` | string / number / null | нет | Единица повторения: `day`, `week`, `month` или `year`. Принимаются также числовые коды единиц | | `params.multipleInterval` | number / string / null | нет | Целый неотрицательный интервал повторения. Числовая строка также принимается | | `params.offsetBeginDateType` | string / number / null | нет | Единица смещения начала новой сделки: `day`, `week`, `month` или `year`. Принимаются также числовые коды единиц | | `params.offsetBeginDateValue` | number / string / null | нет | Целое неотрицательное смещение начала новой сделки. Числовая строка также принимается | | `params.offsetCloseDateType` | string / number / null | нет | Единица смещения завершения новой сделки: `day`, `week`, `month` или `year`. Принимаются также числовые коды единиц | | `params.offsetCloseDateValue` | number / string / null | нет | Целое неотрицательное смещение завершения новой сделки. Числовая строка также принимается | ## Примеры ### curl — личный ключ ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/recurring-deals" \ -H "X-Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"dealId":51,"isLimit":"T","limitRepeat":1,"startDate":"2027-01-01","params":{"mode":"multiple","multipleType":"month","multipleInterval":1}}' ``` ### curl — OAuth-приложение ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/recurring-deals" \ -H "X-Api-Key: YOUR_APP_KEY" \ -H "Authorization: Bearer USER_SESSION_TOKEN" \ -H "Content-Type: application/json" \ -d '{"dealId":51,"isLimit":"T","limitRepeat":1,"startDate":"2027-01-01","params":{"mode":"multiple","multipleType":"month","multipleInterval":1}}' ``` ### JavaScript — личный ключ ```javascript const response = await fetch('https://vibecode.bitrix24.tech/v1/recurring-deals', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({"dealId":51,"isLimit":"T","limitRepeat":1,"startDate":"2027-01-01","params":{"mode":"multiple","multipleType":"month","multipleInterval":1}}), }) const result = await response.json() if (!result.success) throw new Error(result.error.message) console.log(result.data) ``` ### JavaScript — OAuth-приложение ```javascript const response = await fetch('https://vibecode.bitrix24.tech/v1/recurring-deals', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN', 'Content-Type': 'application/json' }, body: JSON.stringify({"dealId":51,"isLimit":"T","limitRepeat":1,"startDate":"2027-01-01","params":{"mode":"multiple","multipleType":"month","multipleInterval":1}}), }) const result = await response.json() if (!result.success) throw new Error(result.error.message) console.log(result.data) ``` ## Поля ответа | Поле | Тип | Описание | |---|---|---| | `success` | boolean | Признак успешного запроса | | `data` | object | Настройка повторения. Полный состав — [поля регулярной сделки](./fields.md) | ## Пример ответа 201 — настройка создана: ```json { "success": true, "data": { "id": 11, "dealId": 53, "basedId": 51, "active": true, "categoryId": null, "isLimit": "T", "counterRepeat": null, "limitRepeat": 1, "limitDate": null, "startDate": "2027-01-01", "nextExecution": "2026-12-31T22:00:00.000Z", "lastExecution": null, "params": { "mode": "multiple", "singleBeforeStartDateValue": 0, "singleBeforeStartDateType": null, "multipleType": "month", "multipleInterval": 1, "offsetBeginDateType": null, "offsetBeginDateValue": 0, "offsetCloseDateType": null, "offsetCloseDateValue": 0 } } } ``` ## Пример ответа при ошибке 400 — не передан `dealId`: ```json { "success": false, "error": { "code": "MISSING_REQUIRED_FIELDS", "message": "Body field \"dealId\" is required to create recurringDeal." } } ``` ## Ошибки | HTTP | Код | Описание | |---|---|---| | 400 | `MISSING_REQUIRED_FIELDS` | Не передан `dealId` | | 400 | `INVALID_PARAMS` | Некорректный ID сделки, режим ограничения, тип значения или параметр расписания | | 400 | `READONLY_FIELD` | Передано поле только для чтения | | 400 | `NESTED_FIELDS_ENVELOPE` | Поля переданы внутри объекта `fields`. Передавайте их в корне JSON | | 422 | `BITRIX_ERROR` | У сделки-шаблона уже есть настройки. Сообщение: `Deal already have had recurring settings.` | | 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` | | 401 | `TOKEN_MISSING` | Нет настроенных токенов доступа к Битрикс24 | | 403 | `MANAGEMENT_KEY_NO_ENTITY_ACCESS` | Ключ управления не имеет доступа к методам сущностей | | 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` | | 403 | `WRITE_BLOCKED_READONLY_KEY` | После проверки скоупа запись запрещена режимом ключа «только чтение» | | 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал в доступе | | 422 | `BITRIX_ERROR` | Бизнес-отказ Битрикс24 или ограничение тарифа. Причина — в `error.message` | | 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя | | 502 | `BITRIX_UNAVAILABLE` | Сетевой сбой или ошибка сервера Битрикс24 с HTTP-статусом 500 и выше | | 429 | `RATE_LIMITED` | Превышен лимит запросов. Повторите после срока из заголовка `Retry-After` | Полный список общих ошибок API — [Ошибки](/docs/errors). ## Смотрите также - [Поля регулярной сделки](./fields.md) - [Список регулярных сделок](./list.md) - [Регулярные сделки](../recurring-deals.md) - [MCP](/docs/mcp) - [Обновить настройку](./update.md) - [Удалить настройку](./delete.md) - [Сделки](/docs/entities/deals)