{ "openapi": "3.0.3", "info": { "title": "Bitrix24 REST API", "version": "1.0.0", "description": "REST API Битрикс24 предоставляет доступ к CRM, задачам, диску, чатам, телефонии, интернет-магазину, автоматизации и другим модулям. Документация: https://apidocs.bitrix24.ru", "contact": { "name": "Bitrix24 Developer Support", "url": "https://apidocs.bitrix24.ru/support.html" }, "license": { "name": "MIT", "url": "https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE" }, "x-logo": { "url": "https://apidocs.bitrix24.ru/_images/bitrix24logo.svg" } }, "externalDocs": { "description": "Официальная документация REST API Битрикс24", "url": "https://apidocs.bitrix24.ru" }, "servers": [ { "url": "https://{portal}.bitrix24.ru/rest", "description": "Ваш портал Битрикс24 (облако)", "variables": { "portal": { "default": "your-portal", "description": "Поддомен вашего портала Битрикс24" } } }, { "url": "https://{host}/rest", "description": "Коробочная версия Битрикс24 (On-Premise)", "variables": { "host": { "default": "your-bitrix24.example.com", "description": "Хост вашей коробочной версии" } } } ], "security": [ { "AccessToken": [] } ], "tags": [ { "name": "BIconnector" }, { "name": "CRM" }, { "name": "CoPilot / AI" }, { "name": "event-log" }, { "name": "forum" }, { "name": "iblock" }, { "name": "mail" }, { "name": "note" }, { "name": "Бизнес-процессы" }, { "name": "Вайб" }, { "name": "Виджеты" }, { "name": "Генератор документов" }, { "name": "Диск" }, { "name": "Задачи" }, { "name": "Интернет-магазин" }, { "name": "Календарь" }, { "name": "Лента новостей" }, { "name": "Общие методы" }, { "name": "Онлайн-запись" }, { "name": "Опросы" }, { "name": "Открытые линии" }, { "name": "Платёжные системы" }, { "name": "Подпись" }, { "name": "Пользователи" }, { "name": "Почтовые сервисы" }, { "name": "Провайдеры сообщений" }, { "name": "Рабочие группы" }, { "name": "Сайты" }, { "name": "События" }, { "name": "Соглашения" }, { "name": "Структура компании" }, { "name": "Телефония" }, { "name": "Торговый каталог" }, { "name": "Универсальные списки" }, { "name": "Устаревшие методы" }, { "name": "Учёт рабочего времени" }, { "name": "Хранилище данных" }, { "name": "Чат-боты" }, { "name": "Чаты" } ], "paths": { "/BX24.placement.bindEvent": { "post": { "summary": "Установить обработчик события интерфейса BX24.placement.bindEvent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `BX24.placement.bindEvent` устанавливает обработчик события интерфейса. Событие должно быть зарегистрировано текущей точкой встраивания, иначе подписка не сработает.", "operationId": "BX24_placement_bindEvent", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/ui-interaction/bx24-placement-bind-event.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Имя события, на которое подписывается обработчик ||" }, "callback": { "type": "string", "description": "| Функция обратного вызова." } }, "required": [ "event", "callback" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Имя события, на которое подписывается обработчик ||" }, "callback": { "type": "string", "description": "| Функция обратного вызова." } }, "required": [ "event", "callback" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.call": { "post": { "summary": "Вызвать зарегистрированную команду интерфейса BX24.placement.call", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `BX24.placement.call` вызывает команду интерфейса, зарегистрированную текущей точкой встраивания.", "operationId": "BX24_placement_call", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/ui-interaction/bx24-placement-call.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "command": { "type": "string", "description": "| Имя вызываемой команды ||" }, "parameters": { "type": "string", "description": "| Передаваемые параметры. Тип значения зависит от команды: объект, строка, число, массив или `null`. Команды без параметров принимают пустой объект `{}` ||" }, "callback": { "type": "string", "description": "| Функция обратного вызова. В нее приходит результат команды ||" } }, "required": [ "command" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "command": { "type": "string", "description": "| Имя вызываемой команды ||" }, "parameters": { "type": "string", "description": "| Передаваемые параметры. Тип значения зависит от команды: объект, строка, число, массив или `null`. Команды без параметров принимают пустой объект `{}` ||" }, "callback": { "type": "string", "description": "| Функция обратного вызова. В нее приходит результат команды ||" } }, "required": [ "command" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.getInterface": { "post": { "summary": "Получить информацию о js-интерфейсе текущей точки встраивания BX24.placement.getInterface", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `BX24.placement.getInterface` получает информацию о js-интерфейсе текущей точки встраивания: список доступных команд и событий.", "operationId": "BX24_placement_getInterface", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/ui-interaction/bx24-placement-get-interface.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callback": { "type": "string", "description": "| Функция обратного вызова. В нее приходит объект с полями `command` и `event` ||" } }, "required": [ "callback" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "callback": { "type": "string", "description": "| Функция обратного вызова. В нее приходит объект с полями `command` и `event` ||" } }, "required": [ "callback" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.info": { "post": { "summary": "Получить контекст выполнения виджета BX24.placement.info", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `BX24.placement.info` получает контекст вызова обработчика: код точки встраивания, в которой открыт виджет, и параметры, переданные вместе с ней.", "operationId": "BX24_placement_info", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/ui-interaction/bx24-placement-info.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/CATALOG.MEASURE.ON.ADD": { "post": { "summary": "Событие при добавлении единицы измерения CATALOG.MEASURE.ON.ADD", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.MEASURE.ON.ADD` срабатывает при добавлении единицы измерения.", "operationId": "CATALOG_MEASURE_ON_ADD", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/events/catalog-measure-on-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.MEASURE.ON.DELETE": { "post": { "summary": "Событие при удалении единицы измерения CATALOG.MEASURE.ON.DELETE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.MEASURE.ON.DELETE` срабатывает при удалении единицы измерения.", "operationId": "CATALOG_MEASURE_ON_DELETE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/events/catalog-measure-on-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.MEASURE.ON.UPDATE": { "post": { "summary": "Событие при изменении единицы измерения CATALOG.MEASURE.ON.UPDATE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.MEASURE.ON.UPDATE` срабатывает при обновлении единицы измерения.", "operationId": "CATALOG_MEASURE_ON_UPDATE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/events/catalog-measure-on-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленной единице измерения." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях единицы измерения." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор единицы измерения. Получить все поля единицы измерения по ее идентификатору можно с помощью метода catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.ADD": { "post": { "summary": "Событие при добавлении цены CATALOG.PRICE.ON.ADD", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.ON.ADD` срабатывает при добавлении цены.", "operationId": "CATALOG_PRICE_ON_ADD", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/events/catalog-price-on-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.DELETE": { "post": { "summary": "Событие при удалении цены CATALOG.PRICE.ON.DELETE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.ON.DELETE` срабатывает при удалении цены.", "operationId": "CATALOG_PRICE_ON_DELETE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/events/catalog-price-on-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.UPDATE": { "post": { "summary": "Событие при изменении цены CATALOG.PRICE.ON.UPDATE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.ON.UPDATE` срабатывает при обновлении цены.", "operationId": "CATALOG_PRICE_ON_UPDATE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/events/catalog-price-on-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленной цене." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор цены. Получить все поля цены по ее идентификатору можно с помощью метода catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.ADD": { "post": { "summary": "Событие при добавлении типа цены CATALOG.PRICE.TYPE.ON.ADD", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.TYPE.ON.ADD` срабатывает при добавлении типа цены вручную или методами [catalog.priceType.add](../catalog-price-type-add.md), [catalog.pricetype.add](../catalog-price-type-add-rest-v3.md). Сразу после него с тем же `ID` приходит событие [CATALOG.PRICE.TYPE.ON.UPDATE](./catalog-price-type-on-update.md).", "operationId": "CATALOG_PRICE_TYPE_ON_ADD", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/events/catalog-price-type-on-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.DELETE": { "post": { "summary": "Событие при удалении типа цены CATALOG.PRICE.TYPE.ON.DELETE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.TYPE.ON.DELETE` срабатывает при удалении типа цены вручную или методами [catalog.priceType.delete](../catalog-price-type-delete.md), [catalog.pricetype.delete](../catalog-price-type-delete-rest-v3.md).", "operationId": "CATALOG_PRICE_TYPE_ON_DELETE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/events/catalog-price-type-on-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.UPDATE": { "post": { "summary": "Событие при изменении типа цены CATALOG.PRICE.TYPE.ON.UPDATE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRICE.TYPE.ON.UPDATE` срабатывает при изменении типа цены вручную или методами [catalog.priceType.update](../catalog-price-type-update.md), [catalog.pricetype.update](../catalog-price-type-update-rest-v3.md).", "operationId": "CATALOG_PRICE_TYPE_ON_UPDATE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/events/catalog-price-type-on-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленном типе цены." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях типа цены." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор типа цены. Получить все поля типа цены по его идентификатору можно с помощью метода catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.ADD": { "post": { "summary": "Событие при добавлении товара CATALOG.PRODUCT.ON.ADD", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRODUCT.ON.ADD` срабатывает при добавлении товара, комплекта, головного товара, вариации или услуги.", "operationId": "CATALOG_PRODUCT_ON_ADD", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/events/catalog-product-on-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.DELETE": { "post": { "summary": "Событие при удалении товара CATALOG.PRODUCT.ON.DELETE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRODUCT.ON.DELETE` срабатывает при удалении товара, комплекта, головного товара, вариации или услуги.", "operationId": "CATALOG_PRODUCT_ON_DELETE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/events/catalog-product-on-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.UPDATE": { "post": { "summary": "Событие при изменении товара CATALOG.PRODUCT.ON.UPDATE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.PRODUCT.ON.UPDATE` срабатывает при изменении товара, комплекта, головного товара, вариации или услуги.", "operationId": "CATALOG_PRODUCT_ON_UPDATE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/events/catalog-product-on-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об измененном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об измененном товаре." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях товара." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Тип товара:" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.ADD": { "post": { "summary": "Событие при добавлении правила округления цен CATALOG.ROUNDING.ON.ADD", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.ROUNDING.ON.ADD` срабатывает при добавлении правила округления цен.", "operationId": "CATALOG_ROUNDING_ON_ADD", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/events/catalog-rounding-on-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию о добавленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.DELETE": { "post": { "summary": "Событие при удалении правила округления цен CATALOG.ROUNDING.ON.DELETE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.ROUNDING.ON.DELETE` срабатывает при удалении правила округления цен.", "operationId": "CATALOG_ROUNDING_ON_DELETE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/events/catalog-rounding-on-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об удаленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.UPDATE": { "post": { "summary": "Событие при изменении правила округления цен CATALOG.ROUNDING.ON.UPDATE", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Событие `CATALOG.ROUNDING.ON.UPDATE` срабатывает при обновлении правила округления цен.", "operationId": "CATALOG_ROUNDING_ON_UPDATE", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/events/catalog-rounding-on-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Символьный код события." }, "event_handler_id": { "type": "integer", "description": "| Идентификатор обработчика события ||" }, "data": { "type": "object", "description": "| Объект, содержащий информацию об обновленном правиле округления цен." }, "data.FIELDS": { "type": "object", "description": "| Объект, содержащий информацию о полях правила округления цен." }, "ts": { "type": "string", "description": "| Дата и время отправки события из очереди событий ||" }, "auth": { "type": "object", "description": "| Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие." }, "ID": { "type": "string", "description": "| Идентификатор правила округления цен. Получить все поля правила округления цен по его идентификатору можно с помощью метода catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "data.FIELDS", "ts", "auth", "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/access.name": { "post": { "summary": "Получить названия кодов доступа access.name", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `access.name` получает названия кодов доступа. Коды доступа обозначают пользователей, отделы, группы и другие субъекты прав, например в методе [user.access](../users/user-access.md).", "operationId": "access_name", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/system/access-name.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "string", "description": "| Список кодов доступа, названия для которых нужно получить, например `[\"U1\", \"D107\"]`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "string", "description": "| Список кодов доступа, названия для которых нужно получить, например `[\"U1\", \"D107\"]`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/activity.complete": { "post": { "summary": "Завершить дело v 3.0 crm.<тип>.activity.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "activity_complete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-entity-activity-complete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/activity.delete": { "post": { "summary": "Удалить дело v 3.0 crm.<тип>.activity.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "activity_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-entity-activity-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/activity.get": { "post": { "summary": "Получить дело v 3.0 crm.<тип>.activity.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "activity_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-entity-activity-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/activity.list": { "post": { "summary": "Получить список дел элемента v 3.0 crm.<тип>.activity.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "activity_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-entity-activity-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Обязательно условие `[\"ownerId\",\"=\",<идентификатор элемента>]`, например `[[\"ownerId\",\"=\",41],[\"isCompleted\",\"=\",false]]`. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id`, `createdTime`, `updatedTime`, `startTime`, `endTime`, `deadlineTime`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество дел на странице. Значения больше `200` уменьшаются до `200`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество дел, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Обязательно условие `[\"ownerId\",\"=\",<идентификатор элемента>]`, например `[[\"ownerId\",\"=\",41],[\"isCompleted\",\"=\",false]]`. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id`, `createdTime`, `updatedTime`, `startTime`, `endTime`, `deadlineTime`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество дел на странице. Значения больше `200` уменьшаются до `200`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество дел, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/activity.uncomplete": { "post": { "summary": "Вернуть дело в работу v 3.0 crm.<тип>.activity.uncomplete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "activity_uncomplete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-entity-activity-uncomplete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/address.add": { "post": { "summary": "Добавить адрес контакта или компании v 3.0 crm.<тип>.address.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "address_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-entity-address-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями адреса в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "contactId": { "type": "integer", "description": "| Идентификатор контакта. Передается в `crm.contact.address.add`." }, "companyId": { "type": "integer", "description": "| Идентификатор компании. Передается в `crm.company.address.add`." }, "typeId": { "type": "integer", "description": "| Тип адреса." }, "address1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "address2": { "type": "string", "description": "| Квартира или офис ||" }, "city": { "type": "string", "description": "| Город ||" }, "postalCode": { "type": "string", "description": "| Почтовый индекс ||" }, "region": { "type": "string", "description": "| Район ||" }, "province": { "type": "string", "description": "| Область ||" }, "country": { "type": "string", "description": "| Страна ||" }, "countryCode": { "type": "string", "description": "| Код страны из справочника местоположений Битрикс24. Код проверяется по названию страны в `country`: если название не совпадает с названием страны на языке Битрикс24, метод вернет ошибку. Если кода страны нет, не передавайте поле ||" } }, "required": [ "fields", "contactId", "companyId", "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями адреса в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "contactId": { "type": "integer", "description": "| Идентификатор контакта. Передается в `crm.contact.address.add`." }, "companyId": { "type": "integer", "description": "| Идентификатор компании. Передается в `crm.company.address.add`." }, "typeId": { "type": "integer", "description": "| Тип адреса." }, "address1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "address2": { "type": "string", "description": "| Квартира или офис ||" }, "city": { "type": "string", "description": "| Город ||" }, "postalCode": { "type": "string", "description": "| Почтовый индекс ||" }, "region": { "type": "string", "description": "| Район ||" }, "province": { "type": "string", "description": "| Область ||" }, "country": { "type": "string", "description": "| Страна ||" }, "countryCode": { "type": "string", "description": "| Код страны из справочника местоположений Битрикс24. Код проверяется по названию страны в `country`: если название не совпадает с названием страны на языке Битрикс24, метод вернет ошибку. Если кода страны нет, не передавайте поле ||" } }, "required": [ "fields", "contactId", "companyId", "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/address.delete": { "post": { "summary": "Удалить адрес v 3.0 crm.<тип>.address.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "address_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-entity-address-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор, значение зависит от типа владельца:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор, значение зависит от типа владельца:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/address.get": { "post": { "summary": "Получить адрес v 3.0 crm.<тип>.address.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "address_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-entity-address-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор, значение зависит от типа владельца:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор, значение зависит от типа владельца:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/address.list": { "post": { "summary": "Получить адреса контакта или компании v 3.0 crm.<тип>.address.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "address_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-entity-address-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по владельцу обязательно, например `[[\"contactId\",\"=\",3219]]`. Описание параметра ||" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id` и `typeId`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации: `limit` — количество адресов на странице, по умолчанию `50`, `page` — номер страницы, `offset` — сколько адресов пропустить. Ноль и отрицательный `limit`, отрицательный `offset` вызывают ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по владельцу обязательно, например `[[\"contactId\",\"=\",3219]]`. Описание параметра ||" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id` и `typeId`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации: `limit` — количество адресов на странице, по умолчанию `50`, `page` — номер страницы, `offset` — сколько адресов пропустить. Ноль и отрицательный `limit`, отрицательный `offset` вызывают ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/address.update": { "post": { "summary": "Изменить адрес контакта или компании v 3.0 crm.<тип>.address.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "address_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-entity-address-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор адреса." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор адреса." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/ai.engine.list": { "post": { "summary": "Получить список сервисов ai.engine.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `ai.engine.list` возвращает список зарегистрированных AI-сервисов.", "operationId": "ai_engine_list", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/ai/ai-engine-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с условиями фильтрации. Ключ — название поля с необязательным префиксом оператора, значение — искомое значение. Например:" }, "limit": { "type": "integer", "description": "| Максимальное количество элементов в ответе. Если параметр не передан, метод возвращает все найденные записи ||" }, "ID": { "type": "integer", "description": "| Идентификатор сервиса ||" }, "APP_CODE": { "type": "string", "description": "| Код приложения, которому принадлежит сервис." }, "CODE": { "type": "string", "description": "| Символьный код сервиса ||" }, "CATEGORY": { "type": "string", "description": "| Категория сервиса." }, "COMPLETIONS_URL": { "type": "string", "description": "| URL endpoint сервиса ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата и время создания сервиса в формате ISO 8601, например 2026-03-20T09:50:00+03:00 ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с условиями фильтрации. Ключ — название поля с необязательным префиксом оператора, значение — искомое значение. Например:" }, "limit": { "type": "integer", "description": "| Максимальное количество элементов в ответе. Если параметр не передан, метод возвращает все найденные записи ||" }, "ID": { "type": "integer", "description": "| Идентификатор сервиса ||" }, "APP_CODE": { "type": "string", "description": "| Код приложения, которому принадлежит сервис." }, "CODE": { "type": "string", "description": "| Символьный код сервиса ||" }, "CATEGORY": { "type": "string", "description": "| Категория сервиса." }, "COMPLETIONS_URL": { "type": "string", "description": "| URL endpoint сервиса ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата и время создания сервиса в формате ISO 8601, например 2026-03-20T09:50:00+03:00 ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/ai.engine.register": { "post": { "summary": "Зарегистрировать сервис ai.engine.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `ai.engine.register` регистрирует пользовательский AI-сервис.", "operationId": "ai_engine_register", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/ai/ai-engine-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код сервиса." }, "category": { "type": "string", "description": "| Категория сервиса." }, "completions_url": { "type": "string", "description": "| URL endpoint обработчика, который должен отвечать HTTP-статусом `200` при проверке регистрации (подробное описание) ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки сервиса (подробное описание). Если параметр не передан, сохраняется пустой набор настроек ||" }, "code_alias": { "type": "string", "description": "| Псевдоним модели." }, "model_context_type": { "type": "string", "description": "| Способ подсчета контекста." }, "model_context_limit": { "type": "integer", "description": "| Лимит контекста." } }, "required": [ "code", "category", "completions_url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код сервиса." }, "category": { "type": "string", "description": "| Категория сервиса." }, "completions_url": { "type": "string", "description": "| URL endpoint обработчика, который должен отвечать HTTP-статусом `200` при проверке регистрации (подробное описание) ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки сервиса (подробное описание). Если параметр не передан, сохраняется пустой набор настроек ||" }, "code_alias": { "type": "string", "description": "| Псевдоним модели." }, "model_context_type": { "type": "string", "description": "| Способ подсчета контекста." }, "model_context_limit": { "type": "integer", "description": "| Лимит контекста." } }, "required": [ "code", "category", "completions_url" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/ai.engine.unregister": { "post": { "summary": "Удалить сервис ai.engine.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `ai.engine.unregister` удаляет зарегистрированный AI-сервис.", "operationId": "ai_engine_unregister", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/ai/ai-engine-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Символьный код удаляемого сервиса. Код должен совпадать с кодом сервиса, зарегистрированного текущим приложением или без привязки к приложению при вызове через вебхук ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Символьный код удаляемого сервиса. Код должен совпадать с кодом сервиса, зарегистрированного текущим приложением или без привязки к приложению при вызове через вебхук ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/app.info": { "post": { "summary": "Показать информацию о приложении app.info", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `app.info` возвращает информацию о приложении: статус, версию, срок оплаты и тариф Битрикс24, см. также [ответ при вызове через вебхук](#webhook).", "operationId": "app_info", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/system/app-info.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/app.option.get": { "post": { "summary": "Получить общие настройки приложения app.option.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `app.option.get` получает общие настройки приложения, сохраненные через [app.option.set](./app-option-set.md). Настройки одни для всех пользователей Битрикс24.", "operationId": "app_option_get", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/settings/app-option-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| Один из ключей, сохраненных методом app.option.set." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| Один из ключей, сохраненных методом app.option.set." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/app.option.set": { "post": { "summary": "Сохранить общие настройки приложения app.option.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `app.option.set` сохраняет общие настройки приложения — одни для всех пользователей Битрикс24. Прочитать их можно методом [app.option.get](./app-option-get.md).", "operationId": "app_option_set", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/settings/app-option-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "object", "description": "| Объект настроек: ключ — название настройки, значение — ее значение. Передавайте `options` объектом. Не используйте ключи `next` и `total`: при чтении всех настроек REST API вернет их не в `result`, а в корне ответа." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "options": { "type": "object", "description": "| Объект настроек: ключ — название настройки, значение — ее значение. Передавайте `options` объектом. Не используйте ключи `next` и `total`: при чтении всех настроек REST API вернет их не в `result`, а в корне ответа." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/bankrequisite.list": { "post": { "summary": "Получить банковские реквизиты контакта или компании v 3.0 crm.<тип>.bankrequisite.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "bankrequisite_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-bank-requisite-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по владельцу — `companyId` в методе компании, `contactId` в методе контакта: `[\"companyId\",\"=\",<идентификатор>]`. Оператор — только `=`, значение — положительное целое число ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей банковского реквизита, которые нужно вернуть. Описание полей. Поля `companyId` и `contactId` в `select` недоступны." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `id`, `name` и банковским полям, кроме `requisiteId`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество записей на странице, `offset` — сколько записей пропустить. Ноль и отрицательные значения вызывают ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по владельцу — `companyId` в методе компании, `contactId` в методе контакта: `[\"companyId\",\"=\",<идентификатор>]`. Оператор — только `=`, значение — положительное целое число ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей банковского реквизита, которые нужно вернуть. Описание полей. Поля `companyId` и `contactId` в `select` недоступны." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `id`, `name` и банковским полям, кроме `requisiteId`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество записей на странице, `offset` — сколько записей пропустить. Ноль и отрицательные значения вызывают ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/biconnector.connector.add": { "post": { "summary": "Создать коннектор biconnector.connector.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.add` создает новый коннектор.", "operationId": "biconnector_connector_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового коннектора. Формат объекта:" }, "title": { "type": "string", "description": "| Название коннектора, максимальная длина — 512 символов ||" }, "logo": { "type": "string", "description": "| Логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Описание коннектора ||" }, "urlCheck": { "type": "string", "description": "| Эндпоинт коннектора для проверки доступности, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableList": { "type": "string", "description": "| Эндпоинт коннектора для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableDescription": { "type": "string", "description": "| Эндпоинт коннектора для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlData": { "type": "string", "description": "| Эндпоинт коннектора для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание) ||" }, "settings": { "type": "array", "items": {}, "description": "| Массив параметров подключения: коды и названия полей, значения которых пользователь заполнит при создании источника (подробное описание) ||" }, "supportMapping": { "type": "boolean", "description": "| Поддержка сопоставления полей таблицы с полями внешней системы. Значение по умолчанию — `false`." }, "sourceCode": { "type": "string", "description": "| Символьный код внешней системы, максимальная длина — 64 символа ||" }, "sort": { "type": "integer", "description": "| Параметр сортировки коннекторов. Значение по умолчанию — `100` ||" }, "code": { "type": "string", "description": "| Код параметра. С этим названием параметр уходит во внешнюю систему в объекте `connection`. Максимальная длина — 512 символов ||" }, "type": { "type": "string", "description": "| Тип параметра, определяет поле ввода в интерфейсе. Допустимые значения: `STRING`, `INT`. Значение регистрозависимо: `string` в нижнем регистре вызовет ошибку `VALIDATION_SETTINGS_INVALID_TYPE` ||" } }, "required": [ "fields", "title", "logo", "urlCheck", "urlTableList", "urlTableDescription", "urlData", "settings", "code", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового коннектора. Формат объекта:" }, "title": { "type": "string", "description": "| Название коннектора, максимальная длина — 512 символов ||" }, "logo": { "type": "string", "description": "| Логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Описание коннектора ||" }, "urlCheck": { "type": "string", "description": "| Эндпоинт коннектора для проверки доступности, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableList": { "type": "string", "description": "| Эндпоинт коннектора для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableDescription": { "type": "string", "description": "| Эндпоинт коннектора для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlData": { "type": "string", "description": "| Эндпоинт коннектора для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание) ||" }, "settings": { "type": "array", "items": {}, "description": "| Массив параметров подключения: коды и названия полей, значения которых пользователь заполнит при создании источника (подробное описание) ||" }, "supportMapping": { "type": "boolean", "description": "| Поддержка сопоставления полей таблицы с полями внешней системы. Значение по умолчанию — `false`." }, "sourceCode": { "type": "string", "description": "| Символьный код внешней системы, максимальная длина — 64 символа ||" }, "sort": { "type": "integer", "description": "| Параметр сортировки коннекторов. Значение по умолчанию — `100` ||" }, "code": { "type": "string", "description": "| Код параметра. С этим названием параметр уходит во внешнюю систему в объекте `connection`. Максимальная длина — 512 символов ||" }, "type": { "type": "string", "description": "| Тип параметра, определяет поле ввода в интерфейсе. Допустимые значения: `STRING`, `INT`. Значение регистрозависимо: `string` в нижнем регистре вызовет ошибку `VALIDATION_SETTINGS_INVALID_TYPE` ||" } }, "required": [ "fields", "title", "logo", "urlCheck", "urlTableList", "urlTableDescription", "urlData", "settings", "code", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.delete": { "post": { "summary": "Удалить коннектор biconnector.connector.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.delete` удаляет существующий коннектор.", "operationId": "biconnector_connector_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.fields": { "post": { "summary": "Получить поля коннектора biconnector.connector.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.fields` возвращает описание полей коннектора.", "operationId": "biconnector_connector_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.get": { "post": { "summary": "Получить коннектор по id biconnector.connector.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.get` возвращает информацию о коннекторе по идентификатору.", "operationId": "biconnector_connector_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.list": { "post": { "summary": "Получить список коннекторов biconnector.connector.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.list` возвращает список коннекторов по фильтру.", "operationId": "biconnector_connector_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у коннекторов в выборке. Допустимые значения — названия полей из таблицы элемента выборки и `*`. Значение `[\"*\"]` возвращает все поля, оно же используется по умолчанию ||" }, "filter": { "type": "object", "description": "| Фильтр для выборки коннекторов. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр `start`, общий для большинства списочных методов REST API, здесь не работает ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у коннекторов в выборке. Допустимые значения — названия полей из таблицы элемента выборки и `*`. Значение `[\"*\"]` возвращает все поля, оно же используется по умолчанию ||" }, "filter": { "type": "object", "description": "| Фильтр для выборки коннекторов. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр `start`, общий для большинства списочных методов REST API, здесь не работает ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.update": { "post": { "summary": "Обновить коннектор biconnector.connector.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.connector.update` обновляет существующий коннектор.", "operationId": "biconnector_connector_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/connector/biconnector-connector-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные. Формат объекта:" }, "title": { "type": "string", "description": "| Новое название коннектора, максимальная длина — 512 символов ||" }, "logo": { "type": "string", "description": "| Новый логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Новое описание коннектора ||" }, "urlCheck": { "type": "string", "description": "| Новый эндпоинт для проверки доступности коннектора, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableList": { "type": "string", "description": "| Новый эндпоинт для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableDescription": { "type": "string", "description": "| Новый эндпоинт для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlData": { "type": "string", "description": "| Новый эндпоинт для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание) ||" }, "settings": { "type": "array", "items": {}, "description": "| Новый массив параметров подключения. Заменяет прежний целиком (подробное описание) ||" }, "supportMapping": { "type": "boolean", "description": "| Поддержка сопоставления полей таблицы с полями внешней системы. Если поле не передать, у коннектора останется прежнее значение." }, "sourceCode": { "type": "string", "description": "| Символьный код внешней системы, максимальная длина — 64 символа ||" }, "sort": { "type": "integer", "description": "| Новый параметр сортировки коннектора ||" }, "code": { "type": "string", "description": "| Код параметра. С этим названием параметр уходит во внешнюю систему в объекте `connection`. Максимальная длина — 512 символов ||" }, "type": { "type": "string", "description": "| Тип параметра, определяет поле ввода в интерфейсе. Допустимые значения: `STRING`, `INT`. Значение регистрозависимо: `string` в нижнем регистре вызовет ошибку `VALIDATION_SETTINGS_INVALID_TYPE` ||" } }, "required": [ "id", "fields", "code", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные. Формат объекта:" }, "title": { "type": "string", "description": "| Новое название коннектора, максимальная длина — 512 символов ||" }, "logo": { "type": "string", "description": "| Новый логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Новое описание коннектора ||" }, "urlCheck": { "type": "string", "description": "| Новый эндпоинт для проверки доступности коннектора, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableList": { "type": "string", "description": "| Новый эндпоинт для получения списка таблиц, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlTableDescription": { "type": "string", "description": "| Новый эндпоинт для получения описания конкретной таблицы, максимальная длина — 2048 символов, (подробное описание) ||" }, "urlData": { "type": "string", "description": "| Новый эндпоинт для получения данных по выбранной таблице, максимальная длина — 2048 символов, (подробное описание) ||" }, "settings": { "type": "array", "items": {}, "description": "| Новый массив параметров подключения. Заменяет прежний целиком (подробное описание) ||" }, "supportMapping": { "type": "boolean", "description": "| Поддержка сопоставления полей таблицы с полями внешней системы. Если поле не передать, у коннектора останется прежнее значение." }, "sourceCode": { "type": "string", "description": "| Символьный код внешней системы, максимальная длина — 64 символа ||" }, "sort": { "type": "integer", "description": "| Новый параметр сортировки коннектора ||" }, "code": { "type": "string", "description": "| Код параметра. С этим названием параметр уходит во внешнюю систему в объекте `connection`. Максимальная длина — 512 символов ||" }, "type": { "type": "string", "description": "| Тип параметра, определяет поле ввода в интерфейсе. Допустимые значения: `STRING`, `INT`. Значение регистрозависимо: `string` в нижнем регистре вызовет ошибку `VALIDATION_SETTINGS_INVALID_TYPE` ||" } }, "required": [ "id", "fields", "code", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.add": { "post": { "summary": "Создать датасет biconnector.dataset.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.add](../table/biconnector-table-add.md).", "operationId": "biconnector_dataset_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового датасета. Формат объекта:" }, "externalName": { "type": "string", "description": "| Название датасета во внешнем источнике, в приложении. Максимальная длина 512 символов ||" }, "externalCode": { "type": "string", "description": "| Уникальный код датасета во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов ||" }, "sourceId": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет `SOURCE_NOT_FOUND` ||" }, "verboseName": { "type": "string", "description": "| Понятное пользователю название датасета, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание датасета ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц, в которые нужно добавить таблицу датасета. Каждый идентификатор — положительное целое число, группа должна существовать." }, "type": { "type": "string", "description": "| Тип данных поля. Допустимые значения:" } }, "required": [ "fields", "externalName", "externalCode", "sourceId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового датасета. Формат объекта:" }, "externalName": { "type": "string", "description": "| Название датасета во внешнем источнике, в приложении. Максимальная длина 512 символов ||" }, "externalCode": { "type": "string", "description": "| Уникальный код датасета во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов ||" }, "sourceId": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет `SOURCE_NOT_FOUND` ||" }, "verboseName": { "type": "string", "description": "| Понятное пользователю название датасета, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание датасета ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц, в которые нужно добавить таблицу датасета. Каждый идентификатор — положительное целое число, группа должна существовать." }, "type": { "type": "string", "description": "| Тип данных поля. Допустимые значения:" } }, "required": [ "fields", "externalName", "externalCode", "sourceId", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.delete": { "post": { "summary": "Удалить датасет biconnector.dataset.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.delete](../table/biconnector-table-delete.md).", "operationId": "biconnector_dataset_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list или biconnector.dataset.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list или biconnector.dataset.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.fields": { "post": { "summary": "Получить поля датасета biconnector.dataset.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.fields](../table/biconnector-table-fields.md).", "operationId": "biconnector_dataset_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.fields.update": { "post": { "summary": "Обновить поля датасета biconnector.dataset.fields.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.fields.update](../table/biconnector-table-fields-update.md).", "operationId": "biconnector_dataset_fields_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-fields-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list или biconnector.dataset.add ||" }, "add": { "type": "array", "items": {}, "description": "| Массив добавляемых полей. Каждый элемент — объект с тремя обязательными ключами:" }, "update": { "type": "array", "items": {}, "description": "| Массив изменяемых полей. Каждый элемент — объект с ключом `id` и хотя бы одним из ключей `visible` или `description`:" }, "delete": { "type": "string", "description": "| Массив идентификаторов удаляемых полей. Идентификаторы можно получить методом biconnector.dataset.get ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list или biconnector.dataset.add ||" }, "add": { "type": "array", "items": {}, "description": "| Массив добавляемых полей. Каждый элемент — объект с тремя обязательными ключами:" }, "update": { "type": "array", "items": {}, "description": "| Массив изменяемых полей. Каждый элемент — объект с ключом `id` и хотя бы одним из ключей `visible` или `description`:" }, "delete": { "type": "string", "description": "| Массив идентификаторов удаляемых полей. Идентификаторы можно получить методом biconnector.dataset.get ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.get": { "post": { "summary": "Получить датасет по id biconnector.dataset.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.get](../table/biconnector-table-get.md).", "operationId": "biconnector_dataset_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list и biconnector.dataset.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list и biconnector.dataset.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.list": { "post": { "summary": "Получить список датасетов biconnector.dataset.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.list](../table/biconnector-table-list.md).", "operationId": "biconnector_dataset_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у датасетов в выборке. Допустимые значения — названия полей из схемы метода biconnector.dataset.fields и `*`. По умолчанию берутся все поля, допустимо и явное `select: [\"*\"]`." }, "filter": { "type": "object", "description": "| Фильтр для выборки датасетов. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Метод не возвращает ни общее количество датасетов, ни ссылку на с..." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у датасетов в выборке. Допустимые значения — названия полей из схемы метода biconnector.dataset.fields и `*`. По умолчанию берутся все поля, допустимо и явное `select: [\"*\"]`." }, "filter": { "type": "object", "description": "| Фильтр для выборки датасетов. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Метод не возвращает ни общее количество датасетов, ни ссылку на с..." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.update": { "post": { "summary": "Обновить датасет biconnector.dataset.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [biconnector.table.update](../table/biconnector-table-update.md).", "operationId": "biconnector_dataset_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/dataset/biconnector-dataset-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list и biconnector.dataset.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "verboseName": { "type": "string", "description": "| Понятное пользователю название датасета, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание датасета ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц. Таблица датасета окажется ровно в этих группах. Каждый идентификатор — положительное целое число, группа должна существовать." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор датасета, можно получить методами biconnector.dataset.list и biconnector.dataset.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "verboseName": { "type": "string", "description": "| Понятное пользователю название датасета, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание датасета ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц. Таблица датасета окажется ровно в этих группах. Каждый идентификатор — положительное целое число, группа должна существовать." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.add": { "post": { "summary": "Создать источник biconnector.source.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.add` создает новый источник данных, связанный с коннектором.", "operationId": "biconnector_source_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового источника. Формат объекта:" }, "title": { "type": "string", "description": "| Название источника ||" }, "description": { "type": "string", "description": "| Описание источника ||" }, "active": { "type": "boolean", "description": "| Активность источника." }, "connectorId": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list или biconnector.connector.add ||" }, "settings": { "type": "object", "description": "| Значения параметров авторизации (подробное описание) ||" } }, "required": [ "fields", "title", "connectorId", "settings" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания нового источника. Формат объекта:" }, "title": { "type": "string", "description": "| Название источника ||" }, "description": { "type": "string", "description": "| Описание источника ||" }, "active": { "type": "boolean", "description": "| Активность источника." }, "connectorId": { "type": "integer", "description": "| Идентификатор коннектора, можно получить методами biconnector.connector.list или biconnector.connector.add ||" }, "settings": { "type": "object", "description": "| Значения параметров авторизации (подробное описание) ||" } }, "required": [ "fields", "title", "connectorId", "settings" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.delete": { "post": { "summary": "Удалить источник biconnector.source.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.delete` удаляет существующий источник.", "operationId": "biconnector_source_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.fields": { "post": { "summary": "Получить поля источника biconnector.source.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.fields` возвращает описание полей источника.", "operationId": "biconnector_source_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.get": { "post": { "summary": "Получить источник по id biconnector.source.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.get` возвращает информацию об источнике по идентификатору.", "operationId": "biconnector_source_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list и biconnector.source.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list и biconnector.source.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.list": { "post": { "summary": "Получить список источников biconnector.source.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.list` возвращает список источников по фильтру.", "operationId": "biconnector_source_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у источников в выборке. Допустимые значения — названия полей из схемы метода biconnector.source.fields и `*`. По умолчанию берутся все поля, то же дает значение `*`." }, "filter": { "type": "object", "description": "| Фильтр для выборки источников. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр `start`, общий для большинства списочных методов REST API, здесь не работает ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у источников в выборке. Допустимые значения — названия полей из схемы метода biconnector.source.fields и `*`. По умолчанию берутся все поля, то же дает значение `*`." }, "filter": { "type": "object", "description": "| Фильтр для выборки источников. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы результатов. Нумерация начинается с единицы, значение по умолчанию — 1. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Параметр `start`, общий для большинства списочных методов REST API, здесь не работает ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.update": { "post": { "summary": "Обновить источник biconnector.source.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.source.update` обновляет существующий источник.", "operationId": "biconnector_source_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/source/biconnector-source-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list и biconnector.source.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "title": { "type": "string", "description": "| Новое название источника." }, "description": { "type": "string", "description": "| Новое описание источника ||" }, "active": { "type": "boolean", "description": "| Активность источника: `true` — источник включен, `false` — выключен. Неактивный источник перестает отдавать данные." }, "settings": { "type": "object", "description": "| Значения параметров авторизации (подробное описание) ||" } }, "required": [ "id", "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list и biconnector.source.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "title": { "type": "string", "description": "| Новое название источника." }, "description": { "type": "string", "description": "| Новое описание источника ||" }, "active": { "type": "boolean", "description": "| Активность источника: `true` — источник включен, `false` — выключен. Неактивный источник перестает отдавать данные." }, "settings": { "type": "object", "description": "| Значения параметров авторизации (подробное описание) ||" } }, "required": [ "id", "fields", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.add": { "post": { "summary": "Создать таблицу biconnector.table.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.add` создает новую таблицу, связанную с источником данных.", "operationId": "biconnector_table_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания новой таблицы. Формат объекта:" }, "externalName": { "type": "string", "description": "| Название таблицы во внешнем источнике, в приложении. Максимальная длина 512 символов ||" }, "externalCode": { "type": "string", "description": "| Уникальный код таблицы во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов ||" }, "sourceId": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет `SOURCE_NOT_FOUND` ||" }, "verboseName": { "type": "string", "description": "| Понятное пользователю название таблицы, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание таблицы ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц, в которые нужно добавить таблицу. Каждый идентификатор — положительное целое число, группа должна существовать." }, "type": { "type": "string", "description": "| Тип данных колонки. Допустимые значения:" } }, "required": [ "fields", "externalName", "externalCode", "sourceId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий данные для создания новой таблицы. Формат объекта:" }, "externalName": { "type": "string", "description": "| Название таблицы во внешнем источнике, в приложении. Максимальная длина 512 символов ||" }, "externalCode": { "type": "string", "description": "| Уникальный код таблицы во внешнем источнике, используется при выборке данных. Максимальная длина 512 символов ||" }, "sourceId": { "type": "integer", "description": "| Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add. Источник должен принадлежать коннектору текущего приложения, иначе метод вернет `SOURCE_NOT_FOUND` ||" }, "verboseName": { "type": "string", "description": "| Понятное пользователю название таблицы, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание таблицы ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц, в которые нужно добавить таблицу. Каждый идентификатор — положительное целое число, группа должна существовать." }, "type": { "type": "string", "description": "| Тип данных колонки. Допустимые значения:" } }, "required": [ "fields", "externalName", "externalCode", "sourceId", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.delete": { "post": { "summary": "Удалить таблицу biconnector.table.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.delete` удаляет существующую таблицу. Вместе с таблицей удаляются ее поля, настройки и связь с источником.", "operationId": "biconnector_table_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.fields": { "post": { "summary": "Получить поля таблицы biconnector.table.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.fields` возвращает описание полей таблицы.", "operationId": "biconnector_table_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.fields.update": { "post": { "summary": "Обновить колонки таблицы biconnector.table.fields.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.fields.update` обновляет состав колонок существующей таблицы. Схему полей самого объекта «таблица» он не меняет — ее возвращает метод [biconnector.table.fields](./biconnector-table-fields.md).", "operationId": "biconnector_table_fields_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-fields-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add ||" }, "add": { "type": "array", "items": {}, "description": "| Массив добавляемых колонок. Каждый элемент — объект с тремя обязательными ключами:" }, "update": { "type": "array", "items": {}, "description": "| Массив изменяемых колонок. Каждый элемент — объект с ключом `id` и хотя бы одним из ключей `visible` или `description`:" }, "delete": { "type": "string", "description": "| Массив идентификаторов удаляемых колонок. Идентификаторы можно получить методом biconnector.table.get ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list или biconnector.table.add ||" }, "add": { "type": "array", "items": {}, "description": "| Массив добавляемых колонок. Каждый элемент — объект с тремя обязательными ключами:" }, "update": { "type": "array", "items": {}, "description": "| Массив изменяемых колонок. Каждый элемент — объект с ключом `id` и хотя бы одним из ключей `visible` или `description`:" }, "delete": { "type": "string", "description": "| Массив идентификаторов удаляемых колонок. Идентификаторы можно получить методом biconnector.table.get ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.get": { "post": { "summary": "Получить таблицу по id biconnector.table.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.get` возвращает информацию о таблице по идентификатору.", "operationId": "biconnector_table_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.list": { "post": { "summary": "Получить список таблиц biconnector.table.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.list` возвращает список таблиц по фильтру.", "operationId": "biconnector_table_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у таблиц в выборке. Допустимые значения — названия полей из схемы метода biconnector.table.fields и `*`. По умолчанию берутся все поля." }, "filter": { "type": "object", "description": "| Фильтр для выборки таблиц. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Метод не возвращает ни общее количество таблиц, ни ссылку на след..." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у таблиц в выборке. Допустимые значения — названия полей из схемы метода biconnector.table.fields и `*`. По умолчанию берутся все поля." }, "filter": { "type": "object", "description": "| Фильтр для выборки таблиц. Пример формата:" }, "order": { "type": "object", "description": "| Параметры сортировки. Пример формата:" }, "page": { "type": "integer", "description": "| Номер страницы выборки, нумерация начинается с единицы, значение по умолчанию — 1. Размер страницы фиксированный — 50 записей. Нечисловое, нулевое или отрицательное значение ошибки не вызывает: метод молча отдает первую страницу. Метод не возвращает ни общее количество таблиц, ни ссылку на след..." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.table.update": { "post": { "summary": "Обновить таблицу biconnector.table.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `biconnector.table.update` обновляет понятное пользователю название, описание и группы существующей таблицы.", "operationId": "biconnector_table_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/biconnector/table/biconnector-table-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "verboseName": { "type": "string", "description": "| Понятное пользователю название таблицы, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание таблицы ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц. Таблица окажется ровно в этих группах. Каждый идентификатор — положительное целое число, группа должна существовать." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор таблицы, можно получить методами biconnector.table.list и biconnector.table.add ||" }, "fields": { "type": "object", "description": "| Объект, содержащий обновляемые данные." }, "verboseName": { "type": "string", "description": "| Понятное пользователю название таблицы, например `Заказы`. Максимальная длина 255 символов ||" }, "description": { "type": "string", "description": "| Описание таблицы ||" }, "tableGroupIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов групп таблиц. Таблица окажется ровно в этих группах. Каждый идентификатор — положительное целое число, группа должна существовать." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/bizproc.activity.add": { "post": { "summary": "Добавить новое действие bizproc.activity.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.activity.add` добавляет новое действие для использования в бизнес-процессах.", "operationId": "bizproc_activity_add", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор действия. Является уникальным в рамках приложения." }, "HANDLER": { "type": "string", "description": "| URL, на который действие будет отправлять данные через сервер очередей bitrix24." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого будет передан приложению ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должно ли действие ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения действия по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Обязательное, если `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "array", "items": {}, "description": "| Массив значений параметра типа список `'TYPE': select'` вида:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию." } }, "required": [ "CODE", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор действия. Является уникальным в рамках приложения." }, "HANDLER": { "type": "string", "description": "| URL, на который действие будет отправлять данные через сервер очередей bitrix24." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого будет передан приложению ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должно ли действие ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения действия по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Обязательное, если `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "array", "items": {}, "description": "| Массив значений параметра типа список `'TYPE': select'` вида:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию." } }, "required": [ "CODE", "HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.delete": { "post": { "summary": "Удалить действие bizproc.activity.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.activity.delete` удаляет действие для бизнес-процессов, добавленное приложением.", "operationId": "bizproc_activity_delete", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Символьный идентификатор действия приложения ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Символьный идентификатор действия приложения ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.list": { "post": { "summary": "Получить список действий приложения bizproc.activity.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.activity.list` получает список действий, установленных приложением.", "operationId": "bizproc_activity_list", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.log": { "post": { "summary": "Записать информацию в журнал бизнес-процесса bizproc.activity.log", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.activity.log` записывает информацию в журнал бизнес-процесса. Запись событий в журнал должна быть включена в шаблоне бизнес-процесса.", "operationId": "bizproc_activity_log", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| Уникальный ключ, необходимый для отправки события бизнес-процессу." }, "LOG_MESSAGE": { "type": "string", "description": "| Сообщение для записи в лог ||" } }, "required": [ "EVENT_TOKEN", "LOG_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| Уникальный ключ, необходимый для отправки события бизнес-процессу." }, "LOG_MESSAGE": { "type": "string", "description": "| Сообщение для записи в лог ||" } }, "required": [ "EVENT_TOKEN", "LOG_MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.update": { "post": { "summary": "Обновить действие bizproc.activity.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.activity.update` обновляет действие бизнес-процессов, добавленное приложением.", "operationId": "bizproc_activity_update", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор действия ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями действия бизнес-процесса ||" }, "HANDLER": { "type": "string", "description": "| URL, на который действие будет отправлять данные через сервер очередей bitrix24." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого будет передан приложению ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должно ли действие ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения действия по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "array", "items": {}, "description": "| Массив значений параметра типа список `'TYPE': select'` вида:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию." } }, "required": [ "CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор действия ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями действия бизнес-процесса ||" }, "HANDLER": { "type": "string", "description": "| URL, на который действие будет отправлять данные через сервер очередей bitrix24." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого будет передан приложению ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должно ли действие ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения действия по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "array", "items": {}, "description": "| Массив значений параметра типа список `'TYPE': select'` вида:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию." } }, "required": [ "CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.event.send": { "post": { "summary": "Вернуть параметры действию или роботу bizproc.event.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.event.send` возвращает роботу или действию выходные параметры, которые были заданы при регистрации или обновлении робота либо действия.", "operationId": "bizproc_event_send", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-event-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| Токен запуска робота или действия. Битрикс24 передает его на обработчик приложения в поле `event_token`." }, "RETURN_VALUES": { "type": "object", "description": "| Возвращаемые значения робота или действия. Ключи — коды параметров из `RETURN_PROPERTIES`, которые задали методами:" }, "LOG_MESSAGE": { "type": "string", "description": "| Текст для журнала бизнес-процесса." } }, "required": [ "EVENT_TOKEN" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| Токен запуска робота или действия. Битрикс24 передает его на обработчик приложения в поле `event_token`." }, "RETURN_VALUES": { "type": "object", "description": "| Возвращаемые значения робота или действия. Ключи — коды параметров из `RETURN_PROPERTIES`, которые задали методами:" }, "LOG_MESSAGE": { "type": "string", "description": "| Текст для журнала бизнес-процесса." } }, "required": [ "EVENT_TOKEN" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.add": { "post": { "summary": "Зарегистрировать нового робота bizproc.robot.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.robot.add` регистрирует нового робота.", "operationId": "bizproc_robot_add", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор робота. Уникален среди роботов и действий приложения: если у приложения уже есть действие с таким `CODE`, метод вернет ошибку `ERROR_ACTIVITY_ALREADY_INSTALLED`." }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота. Если параметр не передать, пользователь не задан ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должен ли робот ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения робота по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Обязательное, если `USE_PLACEMENT = 'Y'`. Проверяется так же, как `HANDLER`. У каждого робота и действия приложения должен быть свой адрес ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "object", "description": "| Варианты значений для параметра типа список `Type: 'select'`. Ключ — значение варианта, значение — его название:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию. Для `Type = 'select'` указывайте ключ из `Options`." } }, "required": [ "CODE", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Внутренний идентификатор робота. Уникален среди роботов и действий приложения: если у приложения уже есть действие с таким `CODE`, метод вернет ошибку `ERROR_ACTIVITY_ALREADY_INSTALLED`." }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота. Если параметр не передать, пользователь не задан ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должен ли робот ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения робота по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Обязательное, если `USE_PLACEMENT = 'Y'`. Проверяется так же, как `HANDLER`. У каждого робота и действия приложения должен быть свой адрес ||" }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "object", "description": "| Варианты значений для параметра типа список `Type: 'select'`. Ключ — значение варианта, значение — его название:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию. Для `Type = 'select'` указывайте ключ из `Options`." } }, "required": [ "CODE", "HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.delete": { "post": { "summary": "Удалить зарегистрированного робота bizproc.robot.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.robot.delete` удаляет робота, зарегистрированного приложением.", "operationId": "bizproc_robot_delete", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код робота, который это приложение передало в `CODE` при регистрации. Получить коды можно методом bizproc.robot.list ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код робота, который это приложение передало в `CODE` при регистрации. Получить коды можно методом bizproc.robot.list ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.list": { "post": { "summary": "Получить список зарегистрированных приложением роботов bizproc.robot.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.robot.list` возвращает список роботов, зарегистрированных приложением.", "operationId": "bizproc_robot_list", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.update": { "post": { "summary": "Обновить поля робота bizproc.robot.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.robot.update` обновляет поля робота, зарегистрированного приложением.", "operationId": "bizproc_robot_update", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код робота, который это приложение передало в `CODE` при регистрации. Получить коды можно методом bizproc.robot.list ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями робота ||" }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должен ли робот ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения робота по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Проверяется так же, как `HANDLER`." }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "object", "description": "| Варианты значений для параметра типа список `Type: 'select'`. Ключ — значение варианта, значение — его название:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию. Для `Type = 'select'` указывайте ключ из `Options`." } }, "required": [ "CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код робота, который это приложение передало в `CODE` при регистрации. Получить коды можно методом bizproc.robot.list ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями робота ||" }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, на который Битрикс24 отправляет данные робота через сервер очередей." }, "AUTH_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, токен которого Битрикс24 передаст обработчику по умолчанию. Администратор может выбрать другого пользователя в настройках робота ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Должен ли робот ожидать ответа от приложения. Возможные значения:" }, "PROPERTIES": { "type": "object", "description": "| Объект с параметрами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Объект с дополнительными результатами робота. Содержит объекты, каждый из которых описывает параметр робота." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа, который будет определять типы данных для параметров `PROPERTIES` и `RETURN_PROPERTIES`. Состоит из трех элементов типа строка:" }, "FILTER": { "type": "object", "description": "| Объект с правилами ограничения робота по типу документа и редакции." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Дает возможность открывать дополнительные настройки робота в слайдере приложения. Возможные значения:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встройки на стороне приложения. Проверяется так же, как `HANDLER`." }, "Type": { "type": "string", "description": "| Тип параметра. Базовые значения:" }, "Options": { "type": "object", "description": "| Варианты значений для параметра типа список `Type: 'select'`. Ключ — значение варианта, значение — его название:" }, "Required": { "type": "boolean", "description": "| Обязательность параметра. Возможные значения:" }, "Multiple": { "type": "boolean", "description": "| Множественность параметра. Возможные значения:" }, "Default": { "type": "string", "description": "| Значение параметра по умолчанию. Для `Type = 'select'` указывайте ключ из `Options`." } }, "required": [ "CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.complete": { "post": { "summary": "Выполнить задание бизнес-процесса bizproc.task.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод выполняет задание бизнес-процесса:", "operationId": "bizproc_task_complete", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "integer", "description": "| Идентификатор задания." }, "COMMENT": { "type": "string", "description": "| Комментарий пользователя." }, "FIELDS": { "type": "object", "description": "| Объект с описанием полей для выполнения заданий с запросом дополнительной информации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" } }, "required": [ "TASK_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "integer", "description": "| Идентификатор задания." }, "COMMENT": { "type": "string", "description": "| Комментарий пользователя." }, "FIELDS": { "type": "object", "description": "| Объект с описанием полей для выполнения заданий с запросом дополнительной информации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" } }, "required": [ "TASK_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.delegate": { "post": { "summary": "Делегировать задание бизнес-процесса bizproc.task.delegate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод делегирует задание бизнес-процесса. Делегировать можно только свое задание.", "operationId": "bizproc_task_delegate", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_IDS": { "type": "array", "items": {}, "description": "| Список идентификаторов заданий." }, "FROM_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от которого задания будут делегированы." }, "TO_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которому задания будут делегированы." } }, "required": [ "TASK_IDS", "FROM_USER_ID", "TO_USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_IDS": { "type": "array", "items": {}, "description": "| Список идентификаторов заданий." }, "FROM_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от которого задания будут делегированы." }, "TO_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которому задания будут делегированы." } }, "required": [ "TASK_IDS", "FROM_USER_ID", "TO_USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.list": { "post": { "summary": "Получить список заданий бизнес-процесса bizproc.task.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.task.list` получает список заданий бизнес-процессов.", "operationId": "bizproc_task_list", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка заданий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка заданий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "START": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка заданий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка заданий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "START": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.instances": { "post": { "summary": "Получить список запущенных бизнес-процессов bizproc.workflow.instances", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает список запущенных бизнес-процессов.", "operationId": "bizproc_workflow_instances", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-instances.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.kill": { "post": { "summary": "Удалить запущенный процесс bizproc.workflow.kill", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет запущенный бизнес-процесс вместе со всеми данными процесса.", "operationId": "bizproc_workflow_kill", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-kill.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор бизнес-процесса ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор бизнес-процесса ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.start": { "post": { "summary": "Запустить бизнес-процесс bizproc.workflow.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `bizproc.workflow.start` запускает новый бизнес-процесс.", "operationId": "bizproc_workflow_start", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TEMPLATE_ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" }, "DOCUMENT_ID": { "type": "array", "items": {}, "description": "| Идентификатор документа для запуска бизнес-процесса в формате [`модуль`, `объект`, `ID_элемента`]." }, "PARAMETERS": { "type": "object", "description": "| Значения параметров шаблона бизнес-процесса." } }, "required": [ "TEMPLATE_ID", "DOCUMENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TEMPLATE_ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" }, "DOCUMENT_ID": { "type": "array", "items": {}, "description": "| Идентификатор документа для запуска бизнес-процесса в формате [`модуль`, `объект`, `ID_элемента`]." }, "PARAMETERS": { "type": "object", "description": "| Значения параметров шаблона бизнес-процесса." } }, "required": [ "TEMPLATE_ID", "DOCUMENT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.add": { "post": { "summary": "Добавить шаблон бизнес-процесса bizproc.workflow.template.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет шаблон бизнес-процесса из файла.", "operationId": "bizproc_workflow_template_add", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа. Состоит из трех элементов типа строка. Они определяют, к какому типу объектов прикрепить новый шаблон бизнес-процесса." }, "DESCRIPTION": { "type": "string", "description": "| Описание шаблона ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Контент файла с шаблоном бизнес-процесса в формате `.bpt`." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Настройки автозапуска шаблона. Может иметь значение:" } }, "required": [ "DOCUMENT_TYPE", "TEMPLATE_DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Тип документа. Состоит из трех элементов типа строка. Они определяют, к какому типу объектов прикрепить новый шаблон бизнес-процесса." }, "DESCRIPTION": { "type": "string", "description": "| Описание шаблона ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Контент файла с шаблоном бизнес-процесса в формате `.bpt`." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Настройки автозапуска шаблона. Может иметь значение:" } }, "required": [ "DOCUMENT_TYPE", "TEMPLATE_DATA" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.delete": { "post": { "summary": "Удалить шаблон бизнес-процесса bizproc.workflow.template.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет шаблон бизнес-процесса.", "operationId": "bizproc_workflow_template_delete", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.list": { "post": { "summary": "Получить список шаблонов bizproc.workflow.template.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает список шаблонов бизнес-процессов, которые созданы в дизайнере.", "operationId": "bizproc_workflow_template_list", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка шаблонов бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" }, "MODULE_ID": { "type": "string", "description": "| Идентификатор модуля по документу. Возможные значения:" }, "ENTITY": { "type": "string", "description": "| Идентификатор объекта по документу. Возможные значения:" }, "DOCUMENT_TYPE": { "type": "string", "description": "| Тип документа. Возможные значения:" }, "AUTO_EXECUTE": { "type": "integer", "description": "| Флаг автозапуска. Может принимать значения:" }, "TEMPLATE": { "type": "array", "items": {}, "description": "| Массив с описанием структуры действий шаблона ||" }, "PARAMETERS": { "type": "array", "items": {}, "description": "| Параметры шаблона ||" }, "VARIABLES": { "type": "array", "items": {}, "description": "| Переменные шаблона ||" }, "CONSTANTS": { "type": "array", "items": {}, "description": "| Константы шаблона ||" }, "MODIFIED": { "type": "string", "format": "date-time", "description": "| Дата последнего изменения ||" }, "IS_MODIFIED": { "type": "boolean", "description": "| Был ли изменен шаблон. Возможные значения:" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, который создал или изменил шаблон ||" }, "SYSTEM_CODE": { "type": "string", "description": "| Системный код шаблона." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации списка шаблонов бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "ORDER": { "type": "object", "description": "| Объект для сортировки списка запущенных бизнес-процессов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор шаблона бизнес-процесса ||" }, "MODULE_ID": { "type": "string", "description": "| Идентификатор модуля по документу. Возможные значения:" }, "ENTITY": { "type": "string", "description": "| Идентификатор объекта по документу. Возможные значения:" }, "DOCUMENT_TYPE": { "type": "string", "description": "| Тип документа. Возможные значения:" }, "AUTO_EXECUTE": { "type": "integer", "description": "| Флаг автозапуска. Может принимать значения:" }, "TEMPLATE": { "type": "array", "items": {}, "description": "| Массив с описанием структуры действий шаблона ||" }, "PARAMETERS": { "type": "array", "items": {}, "description": "| Параметры шаблона ||" }, "VARIABLES": { "type": "array", "items": {}, "description": "| Переменные шаблона ||" }, "CONSTANTS": { "type": "array", "items": {}, "description": "| Константы шаблона ||" }, "MODIFIED": { "type": "string", "format": "date-time", "description": "| Дата последнего изменения ||" }, "IS_MODIFIED": { "type": "boolean", "description": "| Был ли изменен шаблон. Возможные значения:" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, который создал или изменил шаблон ||" }, "SYSTEM_CODE": { "type": "string", "description": "| Системный код шаблона." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.update": { "post": { "summary": "Изменить шаблон бизнес-процесса bizproc.workflow.template.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет шаблон бизнес-процесса.", "operationId": "bizproc_workflow_template_update", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор шаблона, который нужно обновить ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями шаблона бизнес-процесса." }, "DESCRIPTION": { "type": "string", "description": "| Описание шаблона ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Контент файла с шаблоном бизнес-процесса в формате `.bpt`." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Настройки автозапуска шаблона. Может иметь значение:" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор шаблона, который нужно обновить ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями шаблона бизнес-процесса." }, "DESCRIPTION": { "type": "string", "description": "| Описание шаблона ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Контент файла с шаблоном бизнес-процесса в формате `.bpt`." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Настройки автозапуска шаблона. Может иметь значение:" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.terminate": { "post": { "summary": "Остановить активный бизнес-процесс bizproc.workflow.terminate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод останавливает указанный бизнес-процесс. Все данные бизнес-процесса при этом сохранятся.", "operationId": "bizproc_workflow_terminate", "tags": [ "Бизнес-процессы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-terminate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор бизнес-процесса, который нужно остановить." }, "STATUS": { "type": "string", "description": "| Установить текст статуса ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор бизнес-процесса, который нужно остановить." }, "STATUS": { "type": "string", "description": "| Установить текст статуса ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/booking.v1.booking.add": { "post": { "summary": "Добавить бронирование booking.v1.booking.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.add` добавляет новое бронирование для ресурса.", "operationId": "booking_v1_booking_add", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания бронирования (подробное описание) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов для брони." }, "description": { "type": "string", "description": "| Описание бронирования." }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "fields", "resourceIds", "datePeriod", "from", "to", "timestamp", "timezone" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания бронирования (подробное описание) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов для брони." }, "description": { "type": "string", "description": "| Описание бронирования." }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "fields", "resourceIds", "datePeriod", "from", "to", "timestamp", "timezone" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.list": { "post": { "summary": "Получить список клиентов бронирования booking.v1.booking.client.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.client.list` возвращает список клиентов для указанного бронирования.", "operationId": "booking_v1_booking_client_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/client/booking-v1-booking-client-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.set": { "post": { "summary": "Добавить клиентов к бронированию booking.v1.booking.client.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.client.set` заменяет список клиентов бронирования переданным списком.", "operationId": "booking_v1_booking_client_set", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/client/booking-v1-booking-client-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." }, "clients": { "type": "array", "items": {}, "description": "| Массив клиентов бронирования (подробное описание). В массиве может быть несколько контактов и компаний." }, "id": { "type": "integer", "description": "| Идентификатор существующего контакта или компании CRM." }, "type": { "type": "object", "description": "| Тип клиента (подробное описание) ||" }, "module": { "type": "string", "description": "| Модуль клиента. Возможное значение — `crm` ||" }, "code": { "type": "string", "description": "| Код типа клиента. Возможные значения:" } }, "required": [ "bookingId", "clients", "id", "type", "module", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." }, "clients": { "type": "array", "items": {}, "description": "| Массив клиентов бронирования (подробное описание). В массиве может быть несколько контактов и компаний." }, "id": { "type": "integer", "description": "| Идентификатор существующего контакта или компании CRM." }, "type": { "type": "object", "description": "| Тип клиента (подробное описание) ||" }, "module": { "type": "string", "description": "| Модуль клиента. Возможное значение — `crm` ||" }, "code": { "type": "string", "description": "| Код типа клиента. Возможные значения:" } }, "required": [ "bookingId", "clients", "id", "type", "module", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.unset": { "post": { "summary": "Удалить клиентов из бронирования booking.v1.booking.client.unset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.client.unset` отвязывает от бронирования всех клиентов.", "operationId": "booking_v1_booking_client_unset", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/client/booking-v1-booking-client-unset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.createfromwaitlist": { "post": { "summary": "Создать бронирование из листа ожидания booking.v1.booking.createfromwaitlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.createfromwaitlist` создает бронирование на основе записи из листа ожидания.", "operationId": "booking_v1_booking_createfromwaitlist", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-createfromwaitlist.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания бронирования (подробное описание) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов для брони." }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "waitListId", "fields", "resourceIds", "datePeriod", "from", "to", "timestamp", "timezone" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания бронирования (подробное описание) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов для брони." }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "waitListId", "fields", "resourceIds", "datePeriod", "from", "to", "timestamp", "timezone" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.delete": { "post": { "summary": "Удалить бронирование booking.v1.booking.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.delete` удаляет бронирование.", "operationId": "booking_v1_booking_delete", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.list": { "post": { "summary": "Получить связи бронирования booking.v1.booking.externalData.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.externalData.list` возвращает все связи для указанного бронирования.", "operationId": "booking_v1_booking_externalData_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.set": { "post": { "summary": "Установить связи для бронирования booking.v1.booking.externalData.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.externalData.set` заменяет весь набор связей для указанного бронирования.", "operationId": "booking_v1_booking_externalData_set", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." }, "externalData": { "type": "array", "items": {}, "description": "| Полный набор связей бронирования. Новое значение заменяет все существующие связи. Пустой массив удаляет все связи. Структура объектов описана ниже ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, например `crm` ||" }, "entityTypeId": { "type": "string", "description": "| ID типа объекта, например `DEAL` ||" }, "value": { "type": "string", "description": "| ID элемента, например `1` ||" } }, "required": [ "bookingId", "externalData", "moduleId", "entityTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." }, "externalData": { "type": "array", "items": {}, "description": "| Полный набор связей бронирования. Новое значение заменяет все существующие связи. Пустой массив удаляет все связи. Структура объектов описана ниже ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, например `crm` ||" }, "entityTypeId": { "type": "string", "description": "| ID типа объекта, например `DEAL` ||" }, "value": { "type": "string", "description": "| ID элемента, например `1` ||" } }, "required": [ "bookingId", "externalData", "moduleId", "entityTypeId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.unset": { "post": { "summary": "Удалить связи для бронирования booking.v1.booking.externalData.unset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.externalData.unset` удаляет все связи для указанного бронирования. Метод не принимает идентификатор отдельной связи, поэтому удалить только одну связь нельзя.", "operationId": "booking_v1_booking_externalData_unset", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-unset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.get": { "post": { "summary": "Получить информацию о бронировании booking.v1.booking.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.get` возвращает информацию о бронировании по идентификатору.", "operationId": "booking_v1_booking_get", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.list": { "post": { "summary": "Получить список бронирований booking.v1.booking.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.list` возвращает список бронирований по фильтру. За один вызов приходит одна страница — до 50 бронирований.", "operationId": "booking_v1_booking_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка бронирований, описание доступных полей ниже ||" }, "order": { "type": "object", "description": "| Объект для сортировки списка бронирований. Направление сортировки может принимать значения:" }, "start": { "type": "integer", "description": "| Смещение для постраничной выборки." }, "resourceId": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов." }, "within": { "type": "object", "description": "| Объект для фильтрации по времени брони в формате `{\"dateFrom\": \"0\", \"dateTo\": \"1739262600\"}`, где" }, "createdWithin": { "type": "object", "description": "| Объект для фильтрации по дате создания бронирования с обязательными полями:" }, "client": { "type": "object", "description": "| Объект для фильтрации по клиенту." }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" }, "dateFrom": { "type": "string", "description": "| Сортировка по дате начала ||" }, "dateTo": { "type": "string", "description": "| Сортировка по дате окончания ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка бронирований, описание доступных полей ниже ||" }, "order": { "type": "object", "description": "| Объект для сортировки списка бронирований. Направление сортировки может принимать значения:" }, "start": { "type": "integer", "description": "| Смещение для постраничной выборки." }, "resourceId": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов." }, "within": { "type": "object", "description": "| Объект для фильтрации по времени брони в формате `{\"dateFrom\": \"0\", \"dateTo\": \"1739262600\"}`, где" }, "createdWithin": { "type": "object", "description": "| Объект для фильтрации по дате создания бронирования с обязательными полями:" }, "client": { "type": "object", "description": "| Объект для фильтрации по клиенту." }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" }, "dateFrom": { "type": "string", "description": "| Сортировка по дате начала ||" }, "dateTo": { "type": "string", "description": "| Сортировка по дате окончания ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.update": { "post": { "summary": "Обновить бронирование booking.v1.booking.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.booking.update` обновляет информацию о бронировании.", "operationId": "booking_v1_booking_update", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking/booking-v1-booking-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления брони (подробное описание)||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов." }, "description": { "type": "string", "description": "| Описание бронирования ||" }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "id", "fields", "from", "to", "timestamp", "timezone" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бронирования ||" }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления брони (подробное описание)||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов ресурсов." }, "description": { "type": "string", "description": "| Описание бронирования ||" }, "datePeriod": { "type": "object", "description": "| Объект, содержащий время брони (подробное описание) ||" }, "from": { "type": "object", "description": "| Время начала брони. Структура описана ниже ||" }, "to": { "type": "object", "description": "| Время окончания брони. Структура описана ниже ||" }, "timestamp": { "type": "integer", "description": "| Дата и время в формате Unix timestamp. Например, `1723446900` ||" }, "timezone": { "type": "string", "description": "| Часовой пояс в формате идентификатора IANA. Например, `Europe/Moscow` ||" } }, "required": [ "id", "fields", "from", "to", "timestamp", "timezone" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.clienttype.list": { "post": { "summary": "Получить список типов клиентов booking.v1.clienttype.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.clienttype.list` возвращает список доступных типов клиентов. Метод может не вернуть тип клиента, если с ним не было создано ни одной брони.", "operationId": "booking_v1_clienttype_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/booking-v1-clienttype-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.add": { "post": { "summary": "Добавить новый ресурс booking.v1.resource.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.add` добавляет новый ресурс.", "operationId": "booking_v1_resource_add", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/booking-v1-resource-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания ресурса (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание ресурса." }, "typeId": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "isMain": { "type": "string", "description": "| Как показывать ресурс. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг: можно ли записать еще одного клиента на время, которое у ресурса уже занято. Возможные значения:" }, "isDealCreationEnabled": { "type": "string", "description": "| Создавать ли сделку автоматически по бронированиям ресурса. Возможные значения:" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок для бронирований ресурса. `0` — воронка по умолчанию." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "templateTypeInfo": { "type": "string", "description": "| Тип шаблона сообщения о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах." }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах." }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах." }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах." }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах." }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого." }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах." }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах." }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "fields", "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания ресурса (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание ресурса." }, "typeId": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "isMain": { "type": "string", "description": "| Как показывать ресурс. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг: можно ли записать еще одного клиента на время, которое у ресурса уже занято. Возможные значения:" }, "isDealCreationEnabled": { "type": "string", "description": "| Создавать ли сделку автоматически по бронированиям ресурса. Возможные значения:" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок для бронирований ресурса. `0` — воронка по умолчанию." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "templateTypeInfo": { "type": "string", "description": "| Тип шаблона сообщения о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах." }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах." }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах." }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах." }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах." }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого." }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах." }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах." }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "fields", "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.delete": { "post": { "summary": "Удалить ресурс booking.v1.resource.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.delete` удаляет ресурс.", "operationId": "booking_v1_resource_delete", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/booking-v1-resource-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.get": { "post": { "summary": "Получить ресурс booking.v1.resource.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.get` возвращает информацию о ресурсе по идентификатору.", "operationId": "booking_v1_resource_get", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/booking-v1-resource-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.list": { "post": { "summary": "Получить список ресурсов booking.v1.resource.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.list` возвращает список ресурсов по фильтру. За один вызов приходит одна страница — до 50 ресурсов. Удаленные ресурсы в список не попадают.", "operationId": "booking_v1_resource_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/booking-v1-resource-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "order": { "type": "object", "description": "| Объект для сортировки списка ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." }, "searchQuery": { "type": "string", "description": "| Поисковый запрос. Метод ищет по подстроке в названии ресурса без учета регистра. Описание ресурса в поиск не входит ||" }, "isMain": { "type": "string", "description": "| Фильтр по настройке показа ресурса. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг. Возможные значения: `Y` — разрешен, `N` — запрещен ||" }, "typeId": { "type": "integer", "description": "\\| `array` | Идентификатор типа ресурса или массив идентификаторов. По массиву метод вернет ресурсы всех перечисленных типов." }, "description": { "type": "string", "description": "| Описание ресурса. Метод ищет по полному совпадению ||" }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "order": { "type": "object", "description": "| Объект для сортировки списка ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." }, "searchQuery": { "type": "string", "description": "| Поисковый запрос. Метод ищет по подстроке в названии ресурса без учета регистра. Описание ресурса в поиск не входит ||" }, "isMain": { "type": "string", "description": "| Фильтр по настройке показа ресурса. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг. Возможные значения: `Y` — разрешен, `N` — запрещен ||" }, "typeId": { "type": "integer", "description": "\\| `array` | Идентификатор типа ресурса или массив идентификаторов. По массиву метод вернет ресурсы всех перечисленных типов." }, "description": { "type": "string", "description": "| Описание ресурса. Метод ищет по полному совпадению ||" }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.list": { "post": { "summary": "Получить настройку слотов для ресурса booking.v1.resource.slots.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.slots.list` возвращает настройку временных слотов для указанного ресурса.", "operationId": "booking_v1_resource_slots_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/slots/booking-v1-resource-slots-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.set": { "post": { "summary": "Установить слоты для ресурса booking.v1.resource.slots.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.slots.set` устанавливает временные слоты для указанного ресурса.", "operationId": "booking_v1_resource_slots_set", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/slots/booking-v1-resource-slots-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." }, "slots": { "type": "array", "items": {}, "description": "| Массив объектов, содержащий значения полей для установки временных слотов (подробное описание) ||" }, "from": { "type": "integer", "description": "| Время в минутах от начала суток, с которого доступна бронь. Значение в диапазоне от 0 до 1440. Например, `540` — бронь доступна с 9:00." }, "to": { "type": "integer", "description": "| Время в минутах от начала суток, до которого доступна бронь. Значение в диапазоне от 0 до 1440 и строго больше `from`. Например, `1080` — бронь доступна до 18:00." }, "timezone": { "type": "string", "description": "| Часовой пояс в формате IANA, относительно которого настроено время слота. Например, `Europe/Moscow`." }, "weekDays": { "type": "array", "items": {}, "description": "| Массив доступных дней недели для слота. Возможные значения:" }, "slotSize": { "type": "integer", "description": "| Длительность записи в минутах. Значение не может быть отрицательным ||" }, "isCompanySchedule": { "type": "string", "description": "| Использует ли ресурс рабочее время из расписания компании. Возможные значения:" } }, "required": [ "resourceId", "slots", "timezone", "slotSize" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." }, "slots": { "type": "array", "items": {}, "description": "| Массив объектов, содержащий значения полей для установки временных слотов (подробное описание) ||" }, "from": { "type": "integer", "description": "| Время в минутах от начала суток, с которого доступна бронь. Значение в диапазоне от 0 до 1440. Например, `540` — бронь доступна с 9:00." }, "to": { "type": "integer", "description": "| Время в минутах от начала суток, до которого доступна бронь. Значение в диапазоне от 0 до 1440 и строго больше `from`. Например, `1080` — бронь доступна до 18:00." }, "timezone": { "type": "string", "description": "| Часовой пояс в формате IANA, относительно которого настроено время слота. Например, `Europe/Moscow`." }, "weekDays": { "type": "array", "items": {}, "description": "| Массив доступных дней недели для слота. Возможные значения:" }, "slotSize": { "type": "integer", "description": "| Длительность записи в минутах. Значение не может быть отрицательным ||" }, "isCompanySchedule": { "type": "string", "description": "| Использует ли ресурс рабочее время из расписания компании. Возможные значения:" } }, "required": [ "resourceId", "slots", "timezone", "slotSize" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.unset": { "post": { "summary": "Удалить слоты для ресурса booking.v1.resource.slots.unset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.slots.unset` удаляет настройку временных слотов для указанного ресурса.", "operationId": "booking_v1_resource_slots_unset", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/slots/booking-v1-resource-slots-unset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.update": { "post": { "summary": "Обновить ресурс booking.v1.resource.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resource.update` обновляет существующий ресурс.", "operationId": "booking_v1_resource_update", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/booking-v1-resource-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления ресурса (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание ресурса ||" }, "typeId": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "isMain": { "type": "string", "description": "| Как показывать ресурс. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг: можно ли записать еще одного клиента на время, которое у ресурса уже занято. Возможные значения:" }, "isDealCreationEnabled": { "type": "string", "description": "| Создавать ли сделку автоматически по бронированиям ресурса. Возможные значения:" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок для бронирований ресурса. `0` — воронка по умолчанию." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "templateTypeInfo": { "type": "string", "description": "| Тип шаблона сообщения о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах ||" }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах ||" }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах ||" }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах ||" }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого ||" }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах ||" }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ресурса." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления ресурса (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание ресурса ||" }, "typeId": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "isMain": { "type": "string", "description": "| Как показывать ресурс. Возможные значения:" }, "isOverbookingAllowed": { "type": "string", "description": "| Разрешен ли овербукинг: можно ли записать еще одного клиента на время, которое у ресурса уже занято. Возможные значения:" }, "isDealCreationEnabled": { "type": "string", "description": "| Создавать ли сделку автоматически по бронированиям ресурса. Возможные значения:" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок для бронирований ресурса. `0` — воронка по умолчанию." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "templateTypeInfo": { "type": "string", "description": "| Тип шаблона сообщения о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах ||" }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах ||" }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах ||" }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах ||" }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого ||" }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах ||" }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.add": { "post": { "summary": "Добавить новый тип ресурса booking.v1.resourceType.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resourceType.add` добавляет новый тип ресурса.", "operationId": "booking_v1_resourceType_add", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/resource-type/booking-v1-resourcetype-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания типа ресурса (подробное описание) ||" }, "code": { "type": "string", "description": "| Символьный код типа ресурса. Должен быть уникальным среди типов модуля `booking`." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах." }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах." }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах." }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах." }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах." }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого." }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах." }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах." }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "fields", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания типа ресурса (подробное описание) ||" }, "code": { "type": "string", "description": "| Символьный код типа ресурса. Должен быть уникальным среди типов модуля `booking`." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах." }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах." }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах." }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах." }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах." }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого." }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах." }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах." }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "fields", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.delete": { "post": { "summary": "Удалить тип ресурса booking.v1.resourceType.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resourceType.delete` удаляет тип ресурса.", "operationId": "booking_v1_resourceType_delete", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/resource-type/booking-v1-resourcetype-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.get": { "post": { "summary": "Получить тип ресурса booking.v1.resourceType.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resourceType.get` возвращает информацию о типе ресурса по идентификатору.", "operationId": "booking_v1_resourceType_get", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/resource-type/booking-v1-resourcetype-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.list": { "post": { "summary": "Получить список типов ресурсов booking.v1.resourceType.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resourceType.list` возвращает список типов ресурсов по фильтру. За один вызов приходит одна страница — до 50 типов.", "operationId": "booking_v1_resourceType_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/resource-type/booking-v1-resourcetype-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка типов ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "order": { "type": "object", "description": "| Объект для сортировки списка типов ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." }, "searchQuery": { "type": "string", "description": "| Поисковый запрос. Метод ищет по подстроке в названии типа ресурса без учета регистра ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит тип ресурса. У типов, созданных через REST, значение `booking`." }, "code": { "type": "string", "description": "| Символьный код типа ресурса. Метод ищет по полному совпадению ||" }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации списка типов ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "order": { "type": "object", "description": "| Объект для сортировки списка типов ресурсов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." }, "searchQuery": { "type": "string", "description": "| Поисковый запрос. Метод ищет по подстроке в названии типа ресурса без учета регистра ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит тип ресурса. У типов, созданных через REST, значение `booking`." }, "code": { "type": "string", "description": "| Символьный код типа ресурса. Метод ищет по полному совпадению ||" }, "id": { "type": "string", "description": "| Сортировка по идентификатору ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.update": { "post": { "summary": "Обновить тип ресурса booking.v1.resourceType.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.resourceType.update` обновляет информацию о существующем типе ресурса.", "operationId": "booking_v1_resourceType_update", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/resource/resource-type/booking-v1-resourcetype-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления типа ресурса (подробное описание)." }, "code": { "type": "string", "description": "| Символьный код типа ресурса." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах ||" }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание о записи. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах ||" }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах ||" }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого ||" }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах ||" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах ||" }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа ресурса." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления типа ресурса (подробное описание)." }, "code": { "type": "string", "description": "| Символьный код типа ресурса." }, "isInfoNotificationOn": { "type": "string", "description": "| Сообщение клиенту о записи. Возможные значения:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Сообщение клиенту с запросом подтвердить запись. Возможные значения:" }, "templateTypeConfirmation": { "type": "string", "description": "| Тип шаблона сообщения о подтверждении записи. Возможные значения:" }, "isReminderNotificationOn": { "type": "string", "description": "| Напоминание о записи. Возможные значения:" }, "templateTypeReminder": { "type": "string", "description": "| Тип шаблона сообщения для напоминания. Единственное значение — `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Запрос обратной связи. Возможные значения:" }, "templateTypeFeedback": { "type": "string", "description": "| Тип шаблона сообщения для запроса обратной связи. Возможные значения:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Напоминание, когда клиент опаздывает. Возможные значения:" }, "templateTypeDelayed": { "type": "string", "description": "| Тип шаблона сообщения об опоздании. Возможные значения:" }, "infoNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту приходит сообщение о записи. Указывается в секундах ||" }, "reminderNotificationDelay": { "type": "integer", "description": "| Время до записи, за которое клиенту приходит напоминание о записи. Указывается в секундах." }, "delayedNotificationDelay": { "type": "integer", "description": "| Время, через которое клиенту отправляется сообщение об опоздании. Указывается в секундах ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Время, через которое в календаре включается счетчик. Указывается в секундах ||" }, "confirmationNotificationDelay": { "type": "integer", "description": "| Время до записи, когда клиенту приходит первое сообщение для подтверждения записи. Указывается в секундах ||" }, "confirmationNotificationRepetitions": { "type": "integer", "description": "| Количество сообщений, которые приходят клиенту для подтверждения записи, без учета первого ||" }, "confirmationNotificationRepetitionsInterval": { "type": "integer", "description": "| Интервал между сообщениями о подтверждении записи. Указывается в секундах ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Время до записи, после которого включается счетчик неподтвержденной записи. Указывается в секундах ||" }, "isCancellationNotificationOn": { "type": "string", "description": "| Сообщение клиенту после отмены записи. Возможные значения:" }, "cancellationNotificationDelay": { "type": "integer", "description": "| Время после отмены записи, через которое клиенту приходит сообщение об отмене. Указывается в секундах ||" }, "senderCode": { "type": "string", "description": "| Код сервиса, который отправляет клиенту сообщения. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.add": { "post": { "summary": "Добавить в лист ожидания booking.v1.waitlist.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.add` добавляет запись в лист ожидания.", "operationId": "booking_v1_waitlist_add", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания записи в листе ожидания (подробное описание) ||" }, "note": { "type": "string", "description": "| Заметка к записи в лист ожидания." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для создания записи в листе ожидания (подробное описание) ||" }, "note": { "type": "string", "description": "| Заметка к записи в лист ожидания." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.list": { "post": { "summary": "Получить клиентов записи в листе ожидания booking.v1.waitlist.client.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.client.list` возвращает список клиентов для указанной записи в листе ожидания.", "operationId": "booking_v1_waitlist_client_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/client/booking-v1-waitlist-client-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.set": { "post": { "summary": "Установить клиентов записи в листе ожидания booking.v1.waitlist.client.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.client.set` устанавливает список клиентов для указанной записи в листе ожидания. Клиентами могут быть контакты и компании CRM.", "operationId": "booking_v1_waitlist_client_set", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." }, "clients": { "type": "array", "items": {}, "description": "| Полный список клиентов записи. Каждый элемент — объект с полями `id` и `type`. Структура элемента, поведение пустого массива ||" }, "id": { "type": "integer", "description": "| Идентификатор контакта или компании CRM. Получить можно методом crm.item.list: `entityTypeId: 3` для контактов, `entityTypeId: 4` для компаний ||" }, "type": { "type": "object", "description": "| Тип клиента. Например, `{\"module\": \"crm\", \"code\": \"CONTACT\"}`. Структура объекта ||" }, "module": { "type": "string", "description": "| Модуль клиента. Для контактов и компаний — `crm` ||" }, "code": { "type": "string", "description": "| Код типа клиента:" } }, "required": [ "waitListId", "clients", "id", "type", "module", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." }, "clients": { "type": "array", "items": {}, "description": "| Полный список клиентов записи. Каждый элемент — объект с полями `id` и `type`. Структура элемента, поведение пустого массива ||" }, "id": { "type": "integer", "description": "| Идентификатор контакта или компании CRM. Получить можно методом crm.item.list: `entityTypeId: 3` для контактов, `entityTypeId: 4` для компаний ||" }, "type": { "type": "object", "description": "| Тип клиента. Например, `{\"module\": \"crm\", \"code\": \"CONTACT\"}`. Структура объекта ||" }, "module": { "type": "string", "description": "| Модуль клиента. Для контактов и компаний — `crm` ||" }, "code": { "type": "string", "description": "| Код типа клиента:" } }, "required": [ "waitListId", "clients", "id", "type", "module", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.unset": { "post": { "summary": "Удалить связи с клиентами записи в листе ожидания booking.v1.waitlist.client.unset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.client.unset` удаляет все связи с клиентами указанной записи в листе ожидания. Контакты и компании остаются в CRM.", "operationId": "booking_v1_waitlist_client_unset", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в листе ожидания." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.createfrombooking": { "post": { "summary": "Создать запись в листе ожидания из бронирования booking.v1.waitlist.createfrombooking", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.createfrombooking` создает запись в листе ожидания на основе существующего бронирования.", "operationId": "booking_v1_waitlist_createfrombooking", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-createfrombooking.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования, на основе которого создается запись в листе ожидания." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Идентификатор бронирования, на основе которого создается запись в листе ожидания." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.delete": { "post": { "summary": "Удалить запись из листа ожидания booking.v1.waitlist.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.delete` удаляет запись из листа ожидания.", "operationId": "booking_v1_waitlist_delete", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.externalData.list": { "post": { "summary": "Получить связи записи в лист ожидания booking.v1.waitlist.externalData.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.externalData.list` возвращает связи для указанной записи в листе ожидания.", "operationId": "booking_v1_waitlist_externalData_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.externalData.set": { "post": { "summary": "Установить связи для записи в лист ожидания booking.v1.waitlist.externalData.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.externalData.set` устанавливает связи для указанной записи в листе ожидания.", "operationId": "booking_v1_waitlist_externalData_set", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." }, "externalData": { "type": "array", "items": {}, "description": "| Массив объектов, содержащий объекты для привязки (подробное описание) ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, например `crm` ||" }, "entityTypeId": { "type": "string", "description": "| ID типа объекта, например `DEAL` ||" }, "value": { "type": "string", "description": "| ID элемента, например `1` ||" } }, "required": [ "waitListId", "externalData", "moduleId", "entityTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." }, "externalData": { "type": "array", "items": {}, "description": "| Массив объектов, содержащий объекты для привязки (подробное описание) ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, например `crm` ||" }, "entityTypeId": { "type": "string", "description": "| ID типа объекта, например `DEAL` ||" }, "value": { "type": "string", "description": "| ID элемента, например `1` ||" } }, "required": [ "waitListId", "externalData", "moduleId", "entityTypeId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.externalData.unset": { "post": { "summary": "Удалить связи для записи в лист ожидания booking.v1.waitlist.externalData.unset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.externalData.unset` удаляет связи для указанной записи в листе ожидания.", "operationId": "booking_v1_waitlist_externalData_unset", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-unset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Идентификатор записи в лист ожидания." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.get": { "post": { "summary": "Получить запись из листа ожидания booking.v1.waitlist.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.get` возвращает информацию о записи в листе ожидания по идентификатору.", "operationId": "booking_v1_waitlist_get", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания. Можно получить в методах booking.v1.waitlist.add и booking.v1.waitlist.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания. Можно получить в методах booking.v1.waitlist.add и booking.v1.waitlist.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.list": { "post": { "summary": "Получить список записей из листа ожидания booking.v1.waitlist.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.list` возвращает список записей из листа ожидания по фильтру.", "operationId": "booking_v1_waitlist_list", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации записей листа ожидания." }, "from": { "type": "string", "description": "| Дата начала периода фильтрации в формате `dd.mm.yyyy`, включительно ||" }, "to": { "type": "string", "description": "| Дата окончания периода фильтрации в формате `dd.mm.yyyy`, не включительно ||" } }, "required": [ "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации записей листа ожидания." }, "from": { "type": "string", "description": "| Дата начала периода фильтрации в формате `dd.mm.yyyy`, включительно ||" }, "to": { "type": "string", "description": "| Дата окончания периода фильтрации в формате `dd.mm.yyyy`, не включительно ||" } }, "required": [ "from", "to" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.update": { "post": { "summary": "Обновить запись в листе ожидания booking.v1.waitlist.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `booking.v1.waitlist.update` обновляет информацию о записи в листе ожидания.", "operationId": "booking_v1_waitlist_update", "tags": [ "Онлайн-запись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/booking/waitlist/booking-v1-waitlist-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания ||" }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления записи в листе ожидания (подробное описание) ||" }, "note": { "type": "string", "description": "| Заметка к записи в лист ожидания ||" } }, "required": [ "id", "fields", "note" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи в листе ожидания ||" }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления записи в листе ожидания (подробное описание) ||" }, "note": { "type": "string", "description": "| Заметка к записи в лист ожидания ||" } }, "required": [ "id", "fields", "note" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/calendar.accessibility.get": { "post": { "summary": "Получить занятость пользователей из списка calendar.accessibility.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.accessibility.get` получает занятость пользователей из списка.", "operationId": "calendar_accessibility_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-accessibility-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей ||" }, "from": { "type": "string", "format": "date", "description": "| Дата начала периода для определения занятости в формате `ГГГГ-ММ-ДД`." }, "to": { "type": "string", "format": "date", "description": "| Дата окончания периода для определения занятости в формате `ГГГГ-ММ-ДД`." } }, "required": [ "users", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей ||" }, "from": { "type": "string", "format": "date", "description": "| Дата начала периода для определения занятости в формате `ГГГГ-ММ-ДД`." }, "to": { "type": "string", "format": "date", "description": "| Дата окончания периода для определения занятости в формате `ГГГГ-ММ-ДД`." } }, "required": [ "users", "from", "to" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.add": { "post": { "summary": "Добавить событие calendar.event.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.add` добавляет новое событие в календарь.", "operationId": "calendar_event_add", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `from` ||" }, "to_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `to` ||" }, "section": { "type": "integer", "description": "| Идентификатор календаря." }, "auto_detect_section": { "type": "string", "description": "| Режим автоопределения секции." }, "skip_time": { "type": "string", "description": "| Передать значение даты без времени в параметрах `from` и `to`. Возможные значения:" }, "timezone_from": { "type": "string", "description": "| Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя." }, "timezone_to": { "type": "string", "description": "| Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя." }, "description": { "type": "string", "description": "| Описание события ||" }, "color": { "type": "string", "description": "| Цвет фона события." }, "text_color": { "type": "string", "description": "| Цвет текста события." }, "accessibility": { "type": "string", "description": "| Доступность на время события:" }, "importance": { "type": "string", "description": "| Важность события:" }, "private_event": { "type": "string", "description": "| Отметка, что событие частное. Возможные значения:" }, "rrule": { "type": "object", "description": "| Повторяемость события в виде объекта в терминах стандарта iCalendar (подробное описание)" }, "is_meeting": { "type": "string", "description": "| Признак встречи с участниками события. Возможные значения:" }, "location": { "type": "string", "description": "| Место проведения. Можно передать произвольную строку, например `Офис, 3 этаж`." }, "doCheckOccupancy": { "type": "string", "description": "| Проверять ли занятость переговорной из `location`. Возможные значения:" }, "remind": { "type": "array", "items": {}, "description": "| Массив объектов с описанием напоминаний о событии (подробное описание) ||" }, "attendees": { "type": "array", "items": {}, "description": "| Список идентификаторов участников события." }, "meeting": { "type": "object", "description": "| Объект с параметрами встречи (подробное описание) ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Массив идентификаторов объектов CRM для привязки к событию. Чтобы привязать объекты, перечислите их идентификаторы с префиксами:" }, "FREQ": { "type": "string", "description": "| Частота повторения" }, "COUNT": { "type": "integer", "description": "| Количество повторений ||" }, "INTERVAL": { "type": "integer", "description": "| Интервал между повторениями ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| Дата окончания повторений ||" }, "count": { "type": "integer", "description": "| Числовое значение временного промежутка ||" }, "notify": { "type": "boolean", "description": "| Флаг оповещения о подтверждении или отказе участников ||" }, "reinvite": { "type": "boolean", "description": "| Флаг запроса повторного подтверждения участия при редактировании события ||" }, "allow_invite": { "type": "boolean", "description": "| Флаг разрешения участникам приглашать других в событие ||" }, "hide_guests": { "type": "boolean", "description": "| Флаг скрытия списка участников ||" } }, "required": [ "type", "ownerId", "section" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `from` ||" }, "to_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `to` ||" }, "section": { "type": "integer", "description": "| Идентификатор календаря." }, "auto_detect_section": { "type": "string", "description": "| Режим автоопределения секции." }, "skip_time": { "type": "string", "description": "| Передать значение даты без времени в параметрах `from` и `to`. Возможные значения:" }, "timezone_from": { "type": "string", "description": "| Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя." }, "timezone_to": { "type": "string", "description": "| Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя." }, "description": { "type": "string", "description": "| Описание события ||" }, "color": { "type": "string", "description": "| Цвет фона события." }, "text_color": { "type": "string", "description": "| Цвет текста события." }, "accessibility": { "type": "string", "description": "| Доступность на время события:" }, "importance": { "type": "string", "description": "| Важность события:" }, "private_event": { "type": "string", "description": "| Отметка, что событие частное. Возможные значения:" }, "rrule": { "type": "object", "description": "| Повторяемость события в виде объекта в терминах стандарта iCalendar (подробное описание)" }, "is_meeting": { "type": "string", "description": "| Признак встречи с участниками события. Возможные значения:" }, "location": { "type": "string", "description": "| Место проведения. Можно передать произвольную строку, например `Офис, 3 этаж`." }, "doCheckOccupancy": { "type": "string", "description": "| Проверять ли занятость переговорной из `location`. Возможные значения:" }, "remind": { "type": "array", "items": {}, "description": "| Массив объектов с описанием напоминаний о событии (подробное описание) ||" }, "attendees": { "type": "array", "items": {}, "description": "| Список идентификаторов участников события." }, "meeting": { "type": "object", "description": "| Объект с параметрами встречи (подробное описание) ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Массив идентификаторов объектов CRM для привязки к событию. Чтобы привязать объекты, перечислите их идентификаторы с префиксами:" }, "FREQ": { "type": "string", "description": "| Частота повторения" }, "COUNT": { "type": "integer", "description": "| Количество повторений ||" }, "INTERVAL": { "type": "integer", "description": "| Интервал между повторениями ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| Дата окончания повторений ||" }, "count": { "type": "integer", "description": "| Числовое значение временного промежутка ||" }, "notify": { "type": "boolean", "description": "| Флаг оповещения о подтверждении или отказе участников ||" }, "reinvite": { "type": "boolean", "description": "| Флаг запроса повторного подтверждения участия при редактировании события ||" }, "allow_invite": { "type": "boolean", "description": "| Флаг разрешения участникам приглашать других в событие ||" }, "hide_guests": { "type": "boolean", "description": "| Флаг скрытия списка участников ||" } }, "required": [ "type", "ownerId", "section" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.delete": { "post": { "summary": "Удалить событие calendar.event.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.delete` удаляет событие.", "operationId": "calendar_event_delete", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.get": { "post": { "summary": "Получить список событий календаря calendar.event.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.get` получает список событий календаря.", "operationId": "calendar_event_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from": { "type": "string", "format": "date", "description": "| Дата начала выборки." }, "to": { "type": "string", "format": "date", "description": "| Дата окончания выборки." }, "section": { "type": "array", "items": {}, "description": "| Массив идентификаторов календарей ||" }, "modified_since": { "type": "string", "description": "| Момент, начиная с которого нужны измененные события. Формат — ISO 8601 с обязательным часовым поясом: `2026-10-13T09:00:00+03:00` или `2026-10-13T06:00:00Z`. Дробная часть секунд допускается и отбрасывается." } }, "required": [ "type", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from": { "type": "string", "format": "date", "description": "| Дата начала выборки." }, "to": { "type": "string", "format": "date", "description": "| Дата окончания выборки." }, "section": { "type": "array", "items": {}, "description": "| Массив идентификаторов календарей ||" }, "modified_since": { "type": "string", "description": "| Момент, начиная с которого нужны измененные события. Формат — ISO 8601 с обязательным часовым поясом: `2026-10-13T09:00:00+03:00` или `2026-10-13T06:00:00Z`. Дробная часть секунд допускается и отбрасывается." } }, "required": [ "type", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.get.nearest": { "post": { "summary": "Получить список будущих событий calendar.event.get.nearest", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.get.nearest` получает список ближайших будущих событий календаря за заданное число дней.", "operationId": "calendar_event_get_nearest", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-get-nearest.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "days": { "type": "integer", "description": "| Число дней для выборки, начиная с текущей даты. По умолчанию — `60` ||" }, "forCurrentUser": { "type": "boolean", "description": "| Вывод списка событий для текущего пользователя. По умолчанию — `true` ||" }, "maxEventsCount": { "type": "integer", "description": "| Максимальное число выводимых событий. По умолчанию ограничения нет ||" }, "detailUrl": { "type": "string", "description": "| Шаблон ссылки на календарь, например `/company/personal/user/#user_id#/calendar/`. Метод подставит идентификатор текущего пользователя вместо `#user_id#`, отбросит часть ссылки после `?` и добавит параметры события." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "days": { "type": "integer", "description": "| Число дней для выборки, начиная с текущей даты. По умолчанию — `60` ||" }, "forCurrentUser": { "type": "boolean", "description": "| Вывод списка событий для текущего пользователя. По умолчанию — `true` ||" }, "maxEventsCount": { "type": "integer", "description": "| Максимальное число выводимых событий. По умолчанию ограничения нет ||" }, "detailUrl": { "type": "string", "description": "| Шаблон ссылки на календарь, например `/company/personal/user/#user_id#/calendar/`. Метод подставит идентификатор текущего пользователя вместо `#user_id#`, отбросит часть ссылки после `?` и добавит параметры события." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.getbyid": { "post": { "summary": "Получить событие по id calendar.event.getbyid", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.getbyid` получает информацию о событии календаря по идентификатору.", "operationId": "calendar_event_getbyid", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-get-by-id.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.update": { "post": { "summary": "Обновить событие calendar.event.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.event.update` обновляет существующее событие.", "operationId": "calendar_event_update", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." }, "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `from` ||" }, "to_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `to` ||" }, "section": { "type": "integer", "description": "| Идентификатор календаря ||" }, "skip_time": { "type": "string", "description": "| Передать значение даты без времени в параметрах `from` и `to`. Возможные значения:" }, "timezone_from": { "type": "string", "description": "| Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя." }, "timezone_to": { "type": "string", "description": "| Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя." }, "description": { "type": "string", "description": "| Описание события ||" }, "color": { "type": "string", "description": "| Цвет фона события." }, "text_color": { "type": "string", "description": "| Цвет текста события." }, "accessibility": { "type": "string", "description": "| Доступность на время события:" }, "importance": { "type": "string", "description": "| Важность события:" }, "private_event": { "type": "string", "description": "| Отметка, что событие частное. Возможные значения:" }, "recurrence_mode": { "type": "string", "description": "| Параметр частичного редактирования повторяемого события. Возможные значения:" }, "current_date_from": { "type": "string", "format": "date", "description": "| Дата текущего события для частичного редактирования повторяемого события." }, "rrule": { "type": "object", "description": "| Повторяемость события в виде объекта в терминах стандарта iCalendar (подробное описание) ||" }, "is_meeting": { "type": "string", "description": "| Признак встречи с участниками события. Возможные значения:" }, "location": { "type": "string", "description": "| Место проведения. Можно передать произвольную строку, например `Офис, 3 этаж`." }, "doCheckOccupancy": { "type": "string", "description": "| Проверять ли занятость переговорной из `location`. Возможные значения:" }, "remind": { "type": "array", "items": {}, "description": "| Массив объектов с описанием напоминаний о событии (подробное описание) ||" }, "attendees": { "type": "array", "items": {}, "description": "| Список идентификаторов участников события." }, "host": { "type": "integer", "description": "| Идентификатор организатора встречи." }, "meeting": { "type": "object", "description": "| Объект с параметрами встречи (подробное описание) ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Массив идентификаторов объектов CRM для привязки к событию. Чтобы привязать объекты, перечислите их идентификаторы с префиксами:" }, "FREQ": { "type": "string", "description": "| Частота повторения" }, "COUNT": { "type": "integer", "description": "| Количество повторений ||" }, "INTERVAL": { "type": "integer", "description": "| Интервал между повторениями ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| Дата окончания повторений ||" }, "count": { "type": "integer", "description": "| Числовое значение временного промежутка ||" }, "notify": { "type": "boolean", "description": "| Флаг оповещения о подтверждении или отказе участников ||" }, "reinvite": { "type": "boolean", "description": "| Флаг запроса повторного подтверждения участия при редактировании события ||" }, "allow_invite": { "type": "boolean", "description": "| Флаг разрешения участникам приглашать других в событие ||" }, "hide_guests": { "type": "boolean", "description": "| Флаг скрытия списка участников ||" } }, "required": [ "id", "type", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор события." }, "type": { "type": "string", "description": "| Тип календаря:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "from_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `from` ||" }, "to_ts": { "type": "integer", "description": "| Дата и время в формате timestamp. Можно использовать вместо параметра `to` ||" }, "section": { "type": "integer", "description": "| Идентификатор календаря ||" }, "skip_time": { "type": "string", "description": "| Передать значение даты без времени в параметрах `from` и `to`. Возможные значения:" }, "timezone_from": { "type": "string", "description": "| Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя." }, "timezone_to": { "type": "string", "description": "| Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя." }, "description": { "type": "string", "description": "| Описание события ||" }, "color": { "type": "string", "description": "| Цвет фона события." }, "text_color": { "type": "string", "description": "| Цвет текста события." }, "accessibility": { "type": "string", "description": "| Доступность на время события:" }, "importance": { "type": "string", "description": "| Важность события:" }, "private_event": { "type": "string", "description": "| Отметка, что событие частное. Возможные значения:" }, "recurrence_mode": { "type": "string", "description": "| Параметр частичного редактирования повторяемого события. Возможные значения:" }, "current_date_from": { "type": "string", "format": "date", "description": "| Дата текущего события для частичного редактирования повторяемого события." }, "rrule": { "type": "object", "description": "| Повторяемость события в виде объекта в терминах стандарта iCalendar (подробное описание) ||" }, "is_meeting": { "type": "string", "description": "| Признак встречи с участниками события. Возможные значения:" }, "location": { "type": "string", "description": "| Место проведения. Можно передать произвольную строку, например `Офис, 3 этаж`." }, "doCheckOccupancy": { "type": "string", "description": "| Проверять ли занятость переговорной из `location`. Возможные значения:" }, "remind": { "type": "array", "items": {}, "description": "| Массив объектов с описанием напоминаний о событии (подробное описание) ||" }, "attendees": { "type": "array", "items": {}, "description": "| Список идентификаторов участников события." }, "host": { "type": "integer", "description": "| Идентификатор организатора встречи." }, "meeting": { "type": "object", "description": "| Объект с параметрами встречи (подробное описание) ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Массив идентификаторов объектов CRM для привязки к событию. Чтобы привязать объекты, перечислите их идентификаторы с префиксами:" }, "FREQ": { "type": "string", "description": "| Частота повторения" }, "COUNT": { "type": "integer", "description": "| Количество повторений ||" }, "INTERVAL": { "type": "integer", "description": "| Интервал между повторениями ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| Дата окончания повторений ||" }, "count": { "type": "integer", "description": "| Числовое значение временного промежутка ||" }, "notify": { "type": "boolean", "description": "| Флаг оповещения о подтверждении или отказе участников ||" }, "reinvite": { "type": "boolean", "description": "| Флаг запроса повторного подтверждения участия при редактировании события ||" }, "allow_invite": { "type": "boolean", "description": "| Флаг разрешения участникам приглашать других в событие ||" }, "hide_guests": { "type": "boolean", "description": "| Флаг скрытия списка участников ||" } }, "required": [ "id", "type", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.meeting.status.get": { "post": { "summary": "Получить статус участия текущего пользователя в событии calendar.meeting.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.meeting.status.get` получает статус участия текущего пользователя в событии.", "operationId": "calendar_meeting_status_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-meeting-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "eventId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Идентификатор события." } }, "required": [ "eventId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.meeting.status.set": { "post": { "summary": "Установить статус участия в событии для текущего пользователя calendar.meeting.status.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.meeting.status.set` устанавливает статус участия в событии для текущего пользователя.", "operationId": "calendar_meeting_status_set", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-meeting-status-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Идентификатор события." }, "status": { "type": "string", "description": "| Статус участия в событии. Возможные значения:" } }, "required": [ "eventId", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Идентификатор события." }, "status": { "type": "string", "description": "| Статус участия в событии. Возможные значения:" } }, "required": [ "eventId", "status" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.add": { "post": { "summary": "Добавить ресурс calendar.resource.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.resource.add` добавляет ресурс — то, что бронируют клиенты, например автомобиль или кабинет специалиста.", "operationId": "calendar_resource_add", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/resource/calendar-resource-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.booking.list": { "post": { "summary": "Получить бронирования ресурсов по фильтру calendar.resource.booking.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.resource.booking.list` получает бронирования ресурсов. Как устроено бронирование ресурсов, описано в [обзоре методов](./index.md).", "operationId": "calendar_resource_booking_list", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/resource/calendar-resource-booking-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Условия выборки бронирований (подробное описание) ||" }, "resourceTypeIdList": { "type": "string", "description": "| Список идентификаторов ресурсов. Несмотря на название, это идентификаторы самих ресурсов, а не их типов. Значение должно быть массивом." }, "from": { "type": "string", "format": "date", "description": "| Дата начала периода, например `2024-06-20`. Если передан только `to`, нижней границы нет ||" }, "to": { "type": "string", "format": "date", "description": "| Дата окончания периода, например `2024-08-20`. Если передан только `from`, верхней границы нет ||" }, "resourceIdList": { "type": "string", "description": "| Список идентификаторов бронирований из пользовательского поля типа `resourcebooking` у лидов или сделок в CRM. Можно передать одно число вместо массива." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Условия выборки бронирований (подробное описание) ||" }, "resourceTypeIdList": { "type": "string", "description": "| Список идентификаторов ресурсов. Несмотря на название, это идентификаторы самих ресурсов, а не их типов. Значение должно быть массивом." }, "from": { "type": "string", "format": "date", "description": "| Дата начала периода, например `2024-06-20`. Если передан только `to`, нижней границы нет ||" }, "to": { "type": "string", "format": "date", "description": "| Дата окончания периода, например `2024-08-20`. Если передан только `from`, верхней границы нет ||" }, "resourceIdList": { "type": "string", "description": "| Список идентификаторов бронирований из пользовательского поля типа `resourcebooking` у лидов или сделок в CRM. Можно передать одно число вместо массива." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.delete": { "post": { "summary": "Удалить ресурс calendar.resource.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.resource.delete` удаляет ресурс вместе со всеми его бронированиями. Восстановить удаленный ресурс и бронирования нельзя. Как устроено бронирование ресурсов, описано в [обзоре методов](./index.md).", "operationId": "calendar_resource_delete", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/resource/calendar-resource-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса. Значение должно быть больше `0`." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса. Значение должно быть больше `0`." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.list": { "post": { "summary": "Получить список ресурсов calendar.resource.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.resource.list` получает список всех ресурсов Битрикс24. Ресурсы, удаленные методом [calendar.resource.delete](./calendar-resource-delete.md), в список не попадают. Как устроено бронирование ресурсов, описано в [обзоре методов](./index.md).", "operationId": "calendar_resource_list", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/resource/calendar-resource-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.update": { "post": { "summary": "Обновить ресурс calendar.resource.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.resource.update` меняет название ресурса. Как устроено бронирование ресурсов, описано в [обзоре методов](./index.md).", "operationId": "calendar_resource_update", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/resource/calendar-resource-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса. Значение должно быть больше `0`." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Идентификатор ресурса. Значение должно быть больше `0`." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.add": { "post": { "summary": "Добавить календарь calendar.section.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.section.add` добавляет новый календарь.", "operationId": "calendar_section_add", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-section-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "description": { "type": "string", "description": "| Описание календаря ||" }, "color": { "type": "string", "description": "| Цвет календаря в формате `#RRGGBB`. Значение по умолчанию — `#E6A469` ||" }, "text_color": { "type": "string", "description": "| Цвет текста в календаре в формате `#RRGGBB`. Значение по умолчанию — `#000000` ||" }, "export": { "type": "object", "description": "| Объект параметров экспорта календаря (подробное описание) ||" }, "access": { "type": "object", "description": "| Объект прав доступа к календарю (подробное описание) ||" }, "ALLOW": { "type": "boolean", "description": "| Разрешить экспорт календаря. Возможные значения:" }, "SET": { "type": "string", "description": "| Период, за который производить экспорт. Возможные значения:" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "description": { "type": "string", "description": "| Описание календаря ||" }, "color": { "type": "string", "description": "| Цвет календаря в формате `#RRGGBB`. Значение по умолчанию — `#E6A469` ||" }, "text_color": { "type": "string", "description": "| Цвет текста в календаре в формате `#RRGGBB`. Значение по умолчанию — `#000000` ||" }, "export": { "type": "object", "description": "| Объект параметров экспорта календаря (подробное описание) ||" }, "access": { "type": "object", "description": "| Объект прав доступа к календарю (подробное описание) ||" }, "ALLOW": { "type": "boolean", "description": "| Разрешить экспорт календаря. Возможные значения:" }, "SET": { "type": "string", "description": "| Период, за который производить экспорт. Возможные значения:" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.delete": { "post": { "summary": "Удалить календарь calendar.section.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.section.delete` удаляет календарь вместе со всеми его событиями.", "operationId": "calendar_section_delete", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-section-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "id": { "type": "integer", "description": "| Идентификатор календаря. Если календаря с таким `id` нет, метод вернет ошибку `ERROR_CORE` с текстом EC_ACCESS_DENIED: он не отличает отсутствующий календарь от чужого ||" } }, "required": [ "type", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "id": { "type": "integer", "description": "| Идентификатор календаря. Если календаря с таким `id` нет, метод вернет ошибку `ERROR_CORE` с текстом EC_ACCESS_DENIED: он не отличает отсутствующий календарь от чужого ||" } }, "required": [ "type", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.get": { "post": { "summary": "Получить список календарей calendar.section.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.section.get` получает список календарей указанного типа и владельца, к которым у пользователя есть право просмотра времени событий.", "operationId": "calendar_section_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-section-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Стандартные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Стандартные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.update": { "post": { "summary": "Обновить календарь calendar.section.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.section.update` обновляет календарь: изменяет только переданные параметры.", "operationId": "calendar_section_update", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-section-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "id": { "type": "integer", "description": "| Идентификатор существующего календаря ||" }, "description": { "type": "string", "description": "| Описание календаря. Пустую строку метод игнорирует: очистить описание этим методом нельзя ||" }, "color": { "type": "string", "description": "| Цвет календаря в формате `#RRGGBB`. Если в значении меньше шести шестнадцатеричных символов, метод сохранит цвет `#9dcf00` ||" }, "text_color": { "type": "string", "description": "| Цвет текста в календаре в формате `#RRGGBB`. Если в значении меньше шести шестнадцатеричных символов, метод сохранит цвет `#9dcf00` ||" }, "access": { "type": "object", "description": "| Объект прав доступа к календарю (подробное описание) ||" } }, "required": [ "type", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип календаря. Возможные значения:" }, "ownerId": { "type": "integer", "description": "| Идентификатор владельца календаря." }, "id": { "type": "integer", "description": "| Идентификатор существующего календаря ||" }, "description": { "type": "string", "description": "| Описание календаря. Пустую строку метод игнорирует: очистить описание этим методом нельзя ||" }, "color": { "type": "string", "description": "| Цвет календаря в формате `#RRGGBB`. Если в значении меньше шести шестнадцатеричных символов, метод сохранит цвет `#9dcf00` ||" }, "text_color": { "type": "string", "description": "| Цвет текста в календаре в формате `#RRGGBB`. Если в значении меньше шести шестнадцатеричных символов, метод сохранит цвет `#9dcf00` ||" }, "access": { "type": "object", "description": "| Объект прав доступа к календарю (подробное описание) ||" } }, "required": [ "type", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.settings.get": { "post": { "summary": "Получить основные настройки календаря calendar.settings.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.settings.get` получает основные настройки календаря: рабочий график компании, выходные и праздничные дни, шаблоны ссылок и параметры переговорных.", "operationId": "calendar_settings_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-settings-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.user.settings.get": { "post": { "summary": "Получить пользовательские настройки календаря calendar.user.settings.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.user.settings.get` получает пользовательские настройки календаря.", "operationId": "calendar_user_settings_get", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-user-settings-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.user.settings.set": { "post": { "summary": "Установить пользовательские настройки календаря calendar.user.settings.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `calendar.user.settings.set` устанавливает пользовательские настройки календаря для текущего пользователя.", "operationId": "calendar_user_settings_set", "tags": [ "Календарь" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/calendar/calendar-user-settings-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "| Объект со значениями пользовательских настроек календаря (подробное описание) ||" }, "view": { "type": "string", "description": "| Стандартное представление для календаря. Возможные значения:" }, "showDeclined": { "type": "boolean", "description": "| Показывать события, в которых пользователь отказался принять участие ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Запрещать приглашать в событие, если время занято ||" }, "collapseOffHours": { "type": "string", "description": "| Скрывать нерабочее время в календаре в недельном и дневном представлении. Возможные значения:" }, "showWeekNumbers": { "type": "string", "description": "| Показывать номера недель. Возможные значения:" }, "showTasks": { "type": "string", "description": "| Отображать задачи в календаре. Возможные значения:" }, "syncTasks": { "type": "string", "description": "| Синхронизировать календарь задач. Возможные значения:" }, "showCompletedTasks": { "type": "string", "description": "| Отображать завершенные задачи. Возможные значения:" }, "sendFromEmail": { "type": "string", "description": "| E-mail для отправки почтовых приглашений ||" }, "defaultSections": { "type": "object", "description": "| Настройки предустановленных календарей." }, "defaultReminders": { "type": "object", "description": "| Объект со стандартными настройками напоминаний о событии (подробное описание) ||" }, "type": { "type": "string", "description": "| Временной тип напоминания. Возможные значения:" }, "before": { "type": "integer", "description": "| Сдвиг напоминания в днях до дня события. Используется с типом `daybefore`. При `0` напоминание приходит в день события ||" }, "time": { "type": "integer", "description": "| Время напоминания в минутах от начала дня. Используется с типом `daybefore`. При `before: 0` и `time: 480` напоминание приходит в день события в 08:00 ||" } }, "required": [ "settings" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "| Объект со значениями пользовательских настроек календаря (подробное описание) ||" }, "view": { "type": "string", "description": "| Стандартное представление для календаря. Возможные значения:" }, "showDeclined": { "type": "boolean", "description": "| Показывать события, в которых пользователь отказался принять участие ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Запрещать приглашать в событие, если время занято ||" }, "collapseOffHours": { "type": "string", "description": "| Скрывать нерабочее время в календаре в недельном и дневном представлении. Возможные значения:" }, "showWeekNumbers": { "type": "string", "description": "| Показывать номера недель. Возможные значения:" }, "showTasks": { "type": "string", "description": "| Отображать задачи в календаре. Возможные значения:" }, "syncTasks": { "type": "string", "description": "| Синхронизировать календарь задач. Возможные значения:" }, "showCompletedTasks": { "type": "string", "description": "| Отображать завершенные задачи. Возможные значения:" }, "sendFromEmail": { "type": "string", "description": "| E-mail для отправки почтовых приглашений ||" }, "defaultSections": { "type": "object", "description": "| Настройки предустановленных календарей." }, "defaultReminders": { "type": "object", "description": "| Объект со стандартными настройками напоминаний о событии (подробное описание) ||" }, "type": { "type": "string", "description": "| Временной тип напоминания. Возможные значения:" }, "before": { "type": "integer", "description": "| Сдвиг напоминания в днях до дня события. Используется с типом `daybefore`. При `0` напоминание приходит в день события ||" }, "time": { "type": "integer", "description": "| Время напоминания в минутах от начала дня. Используется с типом `daybefore`. При `before: 0` и `time: 480` напоминание приходит в день события в 08:00 ||" } }, "required": [ "settings" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/call.followup.field.get": { "post": { "summary": "Получить описание поля Follow-up call.followup.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "call_followup_field_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/follow-up/call-followup-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "call" ] } ] } }, "/call.followup.field.list": { "post": { "summary": "Получить список полей Follow-up call.followup.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "call_followup_field_list", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/follow-up/call-followup-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "call" ] } ] } }, "/call.followup.get": { "post": { "summary": "Получить Follow-up звонка call.followup.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "call_followup_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/follow-up/call-followup-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callId": { "type": "integer", "description": "| Идентификатор звонка." }, "select": { "type": "array", "items": {}, "description": "| Список полей и вложенных путей, которые нужно вернуть в ответе." }, "mentionFormat": { "type": "string", "description": "| Формат упоминаний пользователей в текстовых AI-полях." } }, "required": [ "callId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "callId": { "type": "integer", "description": "| Идентификатор звонка." }, "select": { "type": "array", "items": {}, "description": "| Список полей и вложенных путей, которые нужно вернуть в ответе." }, "mentionFormat": { "type": "string", "description": "| Формат упоминаний пользователей в текстовых AI-полях." } }, "required": [ "callId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "call" ] } ] } }, "/call.followup.list": { "post": { "summary": "Получить список Follow-up звонков call.followup.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "call_followup_list", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/follow-up/call-followup-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Условия выборки (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей и вложенных путей, которые нужно вернуть в элементах списка." }, "order": { "type": "object", "description": "| Параметры сортировки (подробное описание)." }, "pagination": { "type": "object", "description": "| Параметры курсорной постраничной навигации (подробное описание) ||" }, "mentionFormat": { "type": "string", "description": "| Формат упоминаний пользователей в текстовых AI-полях." }, "startDate": { "type": "object", "description": "| Период начала звонка (подробное описание) ||" }, "participantId": { "type": "integer", "description": "| Идентификатор участника звонка." }, "chatId": { "type": "integer", "description": "| Идентификатор чата звонка. Метод вернет Follow-up только звонков из этого чата." }, "from": { "type": "string", "description": "| Начало периода в формате ISO 8601. Например: `2026-01-01T00:00:00Z` ||" }, "to": { "type": "string", "description": "| Конец периода в формате ISO 8601. Значение должно быть больше или равно `from` ||" }, "limit": { "type": "integer", "description": "| Размер страницы." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `afterCursor` целиком из предыдущего ответа в том же формате, в котором оно пришло (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор последнего элемента предыдущей страницы ||" } }, "required": [ "filter", "startDate", "from", "to", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Условия выборки (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей и вложенных путей, которые нужно вернуть в элементах списка." }, "order": { "type": "object", "description": "| Параметры сортировки (подробное описание)." }, "pagination": { "type": "object", "description": "| Параметры курсорной постраничной навигации (подробное описание) ||" }, "mentionFormat": { "type": "string", "description": "| Формат упоминаний пользователей в текстовых AI-полях." }, "startDate": { "type": "object", "description": "| Период начала звонка (подробное описание) ||" }, "participantId": { "type": "integer", "description": "| Идентификатор участника звонка." }, "chatId": { "type": "integer", "description": "| Идентификатор чата звонка. Метод вернет Follow-up только звонков из этого чата." }, "from": { "type": "string", "description": "| Начало периода в формате ISO 8601. Например: `2026-01-01T00:00:00Z` ||" }, "to": { "type": "string", "description": "| Конец периода в формате ISO 8601. Значение должно быть больше или равно `from` ||" }, "limit": { "type": "integer", "description": "| Размер страницы." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `afterCursor` целиком из предыдущего ответа в том же формате, в котором оно пришло (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор последнего элемента предыдущей страницы ||" } }, "required": [ "filter", "startDate", "from", "to", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "call" ] } ] } }, "/catalog.catalog.add": { "post": { "summary": "Добавить торговый каталог catalog.catalog.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового торгового каталога. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока, который нужно сделать торговым каталогом. Инфоблок должен существовать и не должен быть торговым каталогом." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС каталога." }, "yandexExport": { "type": "string", "description": "| Признак выгрузки товаров каталога в Яндекс Маркет." }, "subscription": { "type": "string", "description": "| Признак продажи контента. Используется только в коробочной версии." }, "productIblockId": { "type": "integer", "description": "| Идентификатор инфоблока товаров. Передайте, если создаете каталог вариаций для этого инфоблока. Значение не может совпадать с `iblockId`." }, "skuPropertyId": { "type": "integer", "description": "| Идентификатор активного свойства инфоблока `iblockId` типа «Привязка к элементам», которое ссылается на инфоблок `productIblockId`. В этом свойстве вариация хранит идентификатор головного товара." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового торгового каталога. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока, который нужно сделать торговым каталогом. Инфоблок должен существовать и не должен быть торговым каталогом." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС каталога." }, "yandexExport": { "type": "string", "description": "| Признак выгрузки товаров каталога в Яндекс Маркет." }, "subscription": { "type": "string", "description": "| Признак продажи контента. Используется только в коробочной версии." }, "productIblockId": { "type": "integer", "description": "| Идентификатор инфоблока товаров. Передайте, если создаете каталог вариаций для этого инфоблока. Значение не может совпадать с `iblockId`." }, "skuPropertyId": { "type": "integer", "description": "| Идентификатор активного свойства инфоблока `iblockId` типа «Привязка к элементам», которое ссылается на инфоблок `productIblockId`. В этом свойстве вариация хранит идентификатор головного товара." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.delete": { "post": { "summary": "Удалить торговый каталог catalog.catalog.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога, который нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога, который нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.field.get": { "post": { "summary": "Получить поле торгового каталога catalog.catalog.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.field.list": { "post": { "summary": "Получить список полей торгового каталога v 3.0 catalog.catalog.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.get": { "post": { "summary": "Получить значения всех полей торгового каталога v 3.0 catalog.catalog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога. Совпадает с идентификатором инфоблока каталога." }, "select": { "type": "array", "items": {}, "description": "| Список полей торгового каталога, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"productIblockId\"]`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога. Совпадает с идентификатором инфоблока каталога." }, "select": { "type": "array", "items": {}, "description": "| Список полей торгового каталога, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"productIblockId\"]`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.getFields": { "post": { "summary": "Получить доступные поля торгового каталога catalog.catalog.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.catalog.getFields` возвращает описание полей торгового каталога: тип, обязательность и доступность для изменения.", "operationId": "catalog_catalog_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.isOffers": { "post": { "summary": "Проверить, является ли торговый каталог каталогом вариаций catalog.catalog.isOffers", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.catalog.isOffers` проверяет, является ли торговый каталог каталогом вариаций.", "operationId": "catalog_catalog_isOffers", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-is-offers.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор торгового каталога." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор торгового каталога." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.isoffers": { "post": { "summary": "Проверить, является ли торговый каталог каталогом вариаций v 3.0 catalog.catalog.isoffers", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_isoffers", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-is-offers-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.list": { "post": { "summary": "Получить список торговых каталогов v 3.0 catalog.catalog.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей торгового каталога, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"productIblockId\"]`." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"productIblockId\", \">\", 0]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество каталогов на странице." }, "page": { "type": "integer", "description": "| Номер страницы. Смещение вычисляется как `(page - 1) * limit`." }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Значение должно быть кратно `limit`, например `0`, `10`, `20` при `limit`, равном `10`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей торгового каталога, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"productIblockId\"]`." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"productIblockId\", \">\", 0]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество каталогов на странице." }, "page": { "type": "integer", "description": "| Номер страницы. Смещение вычисляется как `(page - 1) * limit`." }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Значение должно быть кратно `limit`, например `0`, `10`, `20` при `limit`, равном `10`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.update": { "post": { "summary": "Изменить торговый каталог catalog.catalog.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_catalog_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/catalog/catalog-catalog-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога." }, "fields": { "type": "object", "description": "| Объект с полями торгового каталога, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС каталога. Значение `0` снимает ставку." }, "yandexExport": { "type": "string", "description": "| Признак выгрузки товаров каталога в Яндекс Маркет." }, "subscription": { "type": "string", "description": "| Признак продажи контента. Используется только в коробочной версии." }, "productIblockId": { "type": "integer", "description": "| Идентификатор инфоблока товаров для каталога вариаций. Значение не может совпадать с идентификатором каталога." }, "skuPropertyId": { "type": "integer", "description": "| Идентификатор активного свойства инфоблока каталога типа «Привязка к элементам», которое ссылается на инфоблок `productIblockId`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор торгового каталога." }, "fields": { "type": "object", "description": "| Объект с полями торгового каталога, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС каталога. Значение `0` снимает ставку." }, "yandexExport": { "type": "string", "description": "| Признак выгрузки товаров каталога в Яндекс Маркет." }, "subscription": { "type": "string", "description": "| Признак продажи контента. Используется только в коробочной версии." }, "productIblockId": { "type": "integer", "description": "| Идентификатор инфоблока товаров для каталога вариаций. Значение не может совпадать с идентификатором каталога." }, "skuPropertyId": { "type": "integer", "description": "| Идентификатор активного свойства инфоблока каталога типа «Привязка к элементам», которое ссылается на инфоблок `productIblockId`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.contract.agent.delete": { "post": { "summary": "Удалить агентский договор catalog.contract.agent.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_contract_agent_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/agent-contract/catalog-contract-agent-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор агентского договора." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор агентского договора." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.contractor.add": { "post": { "summary": "Добавить поставщика catalog.contractor.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_contractor_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/contractor/catalog-contractor-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового поставщика. Описание полей ||" }, "companyName": { "type": "string", "description": "| Название компании поставщика. Поставщик создается как юридическое лицо. Пустое значение вызывает ошибку `Empty name` ||" } }, "required": [ "fields", "companyName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового поставщика. Описание полей ||" }, "companyName": { "type": "string", "description": "| Название компании поставщика. Поставщик создается как юридическое лицо. Пустое значение вызывает ошибку `Empty name` ||" } }, "required": [ "fields", "companyName" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.contractor.field.get": { "post": { "summary": "Получить поле поставщика catalog.contractor.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_contractor_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/contractor/catalog-contractor-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.contractor.field.list": { "post": { "summary": "Получить список полей поставщика catalog.contractor.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_contractor_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/contractor/catalog-contractor-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.add": { "post": { "summary": "Создать документ складского учета v 3.0 catalog.document.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового документа складского учета. Описание полей ||" }, "docType": { "type": "string", "description": "| Тип документа. После создания тип изменить нельзя. Значение передавайте в верхнем регистре: `a` вызывает ошибку." }, "currency": { "type": "string", "description": "| Код валюты документа, например `RUB`. Метод не проверяет, есть ли такая валюта в Битрикс24: несуществующий код сохраняется без ошибки." }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного. Метод не проверяет, есть ли такой пользователь: несуществующий идентификатор сохраняется без ошибки." }, "title": { "type": "string", "description": "| Название документа. Если не передать, Битрикс24 сформирует название по типу и порядковому номеру документа этого типа, например «Приходная накладная #44». Номер в названии не совпадает с `id` ||" }, "docNumber": { "type": "string", "description": "| Номер входящего документа ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Дата документа в формате ISO 8601 с временем, например `2026-10-22T10:00:00+03:00`. Дата без времени вызывает ошибку валидации ||" }, "total": { "type": "number", "format": "double", "description": "| Сумма документа ||" }, "commentary": { "type": "string", "description": "| Комментарий ||" }, "siteId": { "type": "string", "description": "| Идентификатор сайта. Значение метод не проверяет." }, "statusBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил статус ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил документ. Значение сохраняется, только если метод вызывает администратор. В остальных случаях подставляется текущий пользователь ||" }, "contractorId": { "type": "integer", "description": "| Идентификатор поставщика из справочника каталога. Если в Битрикс24 поставщики ведутся в CRM, поле не сохраняется. Привязать поставщика CRM к документу можно методом catalog.document.contractor.add ||" } }, "required": [ "fields", "docType", "currency", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового документа складского учета. Описание полей ||" }, "docType": { "type": "string", "description": "| Тип документа. После создания тип изменить нельзя. Значение передавайте в верхнем регистре: `a` вызывает ошибку." }, "currency": { "type": "string", "description": "| Код валюты документа, например `RUB`. Метод не проверяет, есть ли такая валюта в Битрикс24: несуществующий код сохраняется без ошибки." }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного. Метод не проверяет, есть ли такой пользователь: несуществующий идентификатор сохраняется без ошибки." }, "title": { "type": "string", "description": "| Название документа. Если не передать, Битрикс24 сформирует название по типу и порядковому номеру документа этого типа, например «Приходная накладная #44». Номер в названии не совпадает с `id` ||" }, "docNumber": { "type": "string", "description": "| Номер входящего документа ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Дата документа в формате ISO 8601 с временем, например `2026-10-22T10:00:00+03:00`. Дата без времени вызывает ошибку валидации ||" }, "total": { "type": "number", "format": "double", "description": "| Сумма документа ||" }, "commentary": { "type": "string", "description": "| Комментарий ||" }, "siteId": { "type": "string", "description": "| Идентификатор сайта. Значение метод не проверяет." }, "statusBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил статус ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил документ. Значение сохраняется, только если метод вызывает администратор. В остальных случаях подставляется текущий пользователь ||" }, "contractorId": { "type": "integer", "description": "| Идентификатор поставщика из справочника каталога. Если в Битрикс24 поставщики ведутся в CRM, поле не сохраняется. Привязать поставщика CRM к документу можно методом catalog.document.contractor.add ||" } }, "required": [ "fields", "docType", "currency", "responsibleId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.cancel": { "post": { "summary": "Отменить проведение документа складского учета v 3.0 catalog.document.cancel", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_cancel", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-cancel-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.cancelList": { "post": { "summary": "Отменить проведение нескольких документов catalog.document.cancelList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.document.cancelList` отменяет проведение нескольких документов складского учета.", "operationId": "catalog_document_cancelList", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-cancel-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.cancellist": { "post": { "summary": "Отменить проведение нескольких документов v 3.0 catalog.document.cancellist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_cancellist", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-cancel-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.conduct": { "post": { "summary": "Провести документ складского учета v 3.0 catalog.document.conduct", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_conduct", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-conduct-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.conductList": { "post": { "summary": "Провести несколько документов складского учета catalog.document.conductList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.document.conductList` проводит несколько документов складского учета.", "operationId": "catalog_document_conductList", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-conduct-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.conductlist": { "post": { "summary": "Провести несколько документов складского учета v 3.0 catalog.document.conductlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_conductlist", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-conduct-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов складского учета, например `[321, 323]`." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.confirm": { "post": { "summary": "Провести один документ складского учета v 3.0 catalog.document.confirm", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_confirm", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-confirm-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.contractor.add": { "post": { "summary": "Добавить поставщика к документу складского учета v 3.0 catalog.document.contractor.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_contractor_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой привязки. Описание полей ||" }, "documentId": { "type": "integer", "description": "| Идентификатор документа прихода с типом `A`. Документ не должен быть проведен." }, "entityTypeId": { "type": "integer", "description": "| Тип объекта CRM." }, "entityId": { "type": "integer", "description": "| Идентификатор контакта или компании." } }, "required": [ "fields", "documentId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой привязки. Описание полей ||" }, "documentId": { "type": "integer", "description": "| Идентификатор документа прихода с типом `A`. Документ не должен быть проведен." }, "entityTypeId": { "type": "integer", "description": "| Тип объекта CRM." }, "entityId": { "type": "integer", "description": "| Идентификатор контакта или компании." } }, "required": [ "fields", "documentId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.contractor.delete": { "post": { "summary": "Удалить привязку поставщика к документу v 3.0 catalog.document.contractor.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_contractor_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор привязки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор привязки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.contractor.field.get": { "post": { "summary": "Получить поле привязки поставщика к документу catalog.document.contractor.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_contractor_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.contractor.field.list": { "post": { "summary": "Получить список полей привязки поставщика к документу v 3.0 catalog.document.contractor.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_contractor_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.contractor.list": { "post": { "summary": "Получить список привязок поставщиков к документам v 3.0 catalog.document.contractor.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_contractor_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей привязки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"documentId\", \"=\", 325]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"asc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей привязки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"documentId\", \"=\", 325]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"asc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.delete": { "post": { "summary": "Удалить документ складского учета v 3.0 catalog.document.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа. Проведенный документ удалить нельзя." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа. Проведенный документ удалить нельзя." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.deleteList": { "post": { "summary": "Удалить несколько документов складского учета catalog.document.deleteList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.document.deleteList` удаляет несколько документов складского учета, которые не проведены.", "operationId": "catalog_document_deleteList", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-delete-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| Массив идентификаторов документов, например `[142, 143, 144]`." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.deletelist": { "post": { "summary": "Удалить несколько документов складского учета v 3.0 catalog.document.deletelist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_deletelist", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-delete-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов, например `[345, 347]`. Нулевые и отрицательные значения пропускаются." } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов документов, например `[345, 347]`. Нулевые и отрицательные значения пропускаются." } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.add": { "post": { "summary": "Добавить товар в документ складского учета v 3.0 catalog.document.element.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой товарной позиции. Описание полей ||" }, "docId": { "type": "integer", "description": "| Идентификатор документа складского учета. Документ не должен быть проведен." }, "elementId": { "type": "integer", "description": "| Идентификатор товара." }, "storeFrom": { "type": "integer", "description": "| Идентификатор склада, с которого списывается товар. Используется в документах перемещения и списания." }, "storeTo": { "type": "integer", "description": "| Идентификатор склада, на который поступает товар. Используется в документах прихода, оприходования, перемещения и возврата." }, "amount": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена в валюте документа ||" } }, "required": [ "fields", "docId", "elementId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой товарной позиции. Описание полей ||" }, "docId": { "type": "integer", "description": "| Идентификатор документа складского учета. Документ не должен быть проведен." }, "elementId": { "type": "integer", "description": "| Идентификатор товара." }, "storeFrom": { "type": "integer", "description": "| Идентификатор склада, с которого списывается товар. Используется в документах перемещения и списания." }, "storeTo": { "type": "integer", "description": "| Идентификатор склада, на который поступает товар. Используется в документах прихода, оприходования, перемещения и возврата." }, "amount": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена в валюте документа ||" } }, "required": [ "fields", "docId", "elementId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.delete": { "post": { "summary": "Удалить товар из документа складского учета v 3.0 catalog.document.element.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции. Позицию можно удалить только из непроведенного документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции. Позицию можно удалить только из непроведенного документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.field.get": { "post": { "summary": "Получить поле товара в документе складского учета catalog.document.element.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.field.list": { "post": { "summary": "Получить список полей товаров для документа складского учета v 3.0 catalog.document.element.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.fields": { "post": { "summary": "Получить список полей товаров документа складского учета catalog.document.element.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.document.element.getFields](../document-element/catalog-document-element-get-fields.md).", "operationId": "catalog_document_element_fields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/outdated/catalog-document-element-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.getFields": { "post": { "summary": "Получить список полей товаров для документа складского учета catalog.document.element.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.document.element.getFields` возвращает описание полей товарной позиции документа складского учета: тип, обязательность и доступность для изменения.", "operationId": "catalog_document_element_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.list": { "post": { "summary": "Получить список товаров в документах складского учета v 3.0 catalog.document.element.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей товарной позиции, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docId\", \"=\", 325]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"asc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей товарной позиции, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docId\", \"=\", 325]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"asc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.update": { "post": { "summary": "Обновить товар в документе складского учета v 3.0 catalog.document.element.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_document_element_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/document-element/catalog-document-element-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект с полями товарной позиции, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "storeFrom": { "type": "integer", "description": "| Идентификатор склада, с которого списывается товар. Используется в документах перемещения и списания." }, "storeTo": { "type": "integer", "description": "| Идентификатор склада, на который поступает товар. Используется в документах прихода, оприходования, перемещения и возврата." }, "amount": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена в валюте документа ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект с полями товарной позиции, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "storeFrom": { "type": "integer", "description": "| Идентификатор склада, с которого списывается товар. Используется в документах перемещения и списания." }, "storeTo": { "type": "integer", "description": "| Идентификатор склада, на который поступает товар. Используется в документах прихода, оприходования, перемещения и возврата." }, "amount": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена в валюте документа ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.field.get": { "post": { "summary": "Получить поле документа складского учета catalog.document.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.field.list": { "post": { "summary": "Получить список полей документа складского учета v 3.0 catalog.document.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.fields": { "post": { "summary": "Получить список полей документа catalog.document.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.document.getFields](../catalog-document-get-fields.md).", "operationId": "catalog_document_fields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/outdated/catalog-document-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.get": { "post": { "summary": "Получить документ складского учета по идентификатору catalog.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "select": { "type": "array", "items": {}, "description": "| Массив полей документа, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "select": { "type": "array", "items": {}, "description": "| Массив полей документа, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.getFields": { "post": { "summary": "Получить описание полей документа складского учета catalog.document.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.document.getFields` возвращает описание полей документа складского учета: тип, обязательность и доступность для изменения.", "operationId": "catalog_document_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.list": { "post": { "summary": "Получить список документов складского учета v 3.0 catalog.document.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей документа, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docType\", \"=\", \"A\"]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество документов на странице. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Страница за пределами списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество документов, которые нужно пропустить от начала списка ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей документа, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docType\", \"=\", \"A\"]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество документов на странице. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Страница за пределами списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество документов, которые нужно пропустить от начала списка ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.mode.field.get": { "post": { "summary": "Получить поле состояния складского учета catalog.document.mode.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_mode_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-mode-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.mode.field.list": { "post": { "summary": "Получить список полей состояния складского учета v 3.0 catalog.document.mode.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_mode_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-mode-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.mode.status": { "post": { "summary": "Проверить состояние складского учета v 3.0 catalog.document.mode.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_mode_status", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-mode-status-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.mode.statusdetails": { "post": { "summary": "Получить состояние и режим складского учета catalog.document.mode.statusdetails", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_mode_statusdetails", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-mode-status-details.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.type.field.get": { "post": { "summary": "Получить поле типа документа catalog.document.type.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_type_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-type-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.type.field.list": { "post": { "summary": "Получить список полей типа документа v 3.0 catalog.document.type.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_type_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-type-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.type.list": { "post": { "summary": "Получить типы документов складского учета catalog.document.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_type_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа документа, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа документа, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.unconfirm": { "post": { "summary": "Отменить проведение одного документа v 3.0 catalog.document.unconfirm", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_unconfirm", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-unconfirm-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.update": { "post": { "summary": "Изменить документ складского учета v 3.0 catalog.document.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "fields": { "type": "object", "description": "| Объект с полями документа складского учета, которые нужно изменить. Описание полей" }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного. Метод не проверяет, есть ли такой пользователь: несуществующий идентификатор сохраняется без ошибки." }, "currency": { "type": "string", "description": "| Код валюты документа, например `RUB`. Метод не проверяет, есть ли такая валюта в Битрикс24." }, "title": { "type": "string", "description": "| Название документа. Пустая строка сохраняется как есть: название по типу и номеру заново не формируется ||" }, "docNumber": { "type": "string", "description": "| Номер входящего документа ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Дата документа в формате ISO 8601 с временем, например `2026-10-22T10:00:00+03:00`. Дата без времени вызывает ошибку валидации ||" }, "total": { "type": "number", "format": "double", "description": "| Сумма документа ||" }, "commentary": { "type": "string", "description": "| Комментарий ||" }, "statusBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил статус ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил документ. Значение сохраняется, только если метод вызывает администратор. В остальных случаях подставляется текущий пользователь ||" }, "contractorId": { "type": "integer", "description": "| Идентификатор поставщика из справочника каталога. Если в Битрикс24 поставщики ведутся в CRM, поле не сохраняется. Привязать поставщика CRM к документу можно методом catalog.document.contractor.add ||" }, "siteId": { "type": "string", "description": "| Идентификатор сайта. Значение метод не проверяет ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "fields": { "type": "object", "description": "| Объект с полями документа складского учета, которые нужно изменить. Описание полей" }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного. Метод не проверяет, есть ли такой пользователь: несуществующий идентификатор сохраняется без ошибки." }, "currency": { "type": "string", "description": "| Код валюты документа, например `RUB`. Метод не проверяет, есть ли такая валюта в Битрикс24." }, "title": { "type": "string", "description": "| Название документа. Пустая строка сохраняется как есть: название по типу и номеру заново не формируется ||" }, "docNumber": { "type": "string", "description": "| Номер входящего документа ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Дата документа в формате ISO 8601 с временем, например `2026-10-22T10:00:00+03:00`. Дата без времени вызывает ошибку валидации ||" }, "total": { "type": "number", "format": "double", "description": "| Сумма документа ||" }, "commentary": { "type": "string", "description": "| Комментарий ||" }, "statusBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил статус ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил документ. Значение сохраняется, только если метод вызывает администратор. В остальных случаях подставляется текущий пользователь ||" }, "contractorId": { "type": "integer", "description": "| Идентификатор поставщика из справочника каталога. Если в Битрикс24 поставщики ведутся в CRM, поле не сохраняется. Привязать поставщика CRM к документу можно методом catalog.document.contractor.add ||" }, "siteId": { "type": "string", "description": "| Идентификатор сайта. Значение метод не проверяет ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.userfield.field.get": { "post": { "summary": "Получить поле для пользовательских полей документов catalog.document.userfield.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_userfield_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.userfield.field.list": { "post": { "summary": "Получить список полей для пользовательских полей документов v 3.0 catalog.document.userfield.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_userfield_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.userfield.list": { "post": { "summary": "Получить список значений пользовательских полей документов складского учета v 3.0 catalog.document.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_userfield_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docType\", \"=\", \"A\"], [\"id\", \"=\", 351]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"docType\", \"=\", \"A\"], [\"id\", \"=\", 351]]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `1000` уменьшаются до `1000`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан, заменяет `offset`. Страница за концом списка возвращает пустой массив ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.userfield.update": { "post": { "summary": "Изменить значения пользовательских полей документов складского учета v 3.0 catalog.document.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_document_userfield_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "fields": { "type": "object", "description": "| Объект с полями пользовательских полей документа, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "docType": { "type": "string", "description": "| Тип документа. Должен совпадать с типом документа `id`, иначе метод вернет ошибку ||" }, "userFields": { "type": "object", "description": "| Значения пользовательских полей. Ключ — `FIELD_{id}`, где `{id}` — идентификатор пользовательского поля, или код поля вида `UF_*`." } }, "required": [ "id", "fields", "docType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа складского учета." }, "fields": { "type": "object", "description": "| Объект с полями пользовательских полей документа, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "docType": { "type": "string", "description": "| Тип документа. Должен совпадать с типом документа `id`, иначе метод вернет ошибку ||" }, "userFields": { "type": "object", "description": "| Значения пользовательских полей. Ключ — `FIELD_{id}`, где `{id}` — идентификатор пользовательского поля, или код поля вида `UF_*`." } }, "required": [ "id", "fields", "docType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.add": { "post": { "summary": "Добавить поставщика к документу складского учета catalog.documentcontractor.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.documentcontractor.add` создает привязку поставщика, контакта или компании к документу складского учета.", "operationId": "catalog_documentcontractor_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля привязки (подробное описание) ||" }, "documentId": { "type": "string", "description": "| Идентификатор документа складского учета типа «Приход» `A`." }, "entityTypeId": { "type": "integer", "description": "| Тип объекта CRM:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента CRM, контакта или компании, из категории «Поставщик». Существование контакта или компании метод не проверяет: несуществующий идентификатор сохранится без ошибки." } }, "required": [ "fields", "documentId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля привязки (подробное описание) ||" }, "documentId": { "type": "string", "description": "| Идентификатор документа складского учета типа «Приход» `A`." }, "entityTypeId": { "type": "integer", "description": "| Тип объекта CRM:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента CRM, контакта или компании, из категории «Поставщик». Существование контакта или компании метод не проверяет: несуществующий идентификатор сохранится без ошибки." } }, "required": [ "fields", "documentId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.delete": { "post": { "summary": "Удалить привязку поставщика к документу catalog.documentcontractor.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.documentcontractor.delete` удаляет поставщика из документа складского учета.", "operationId": "catalog_documentcontractor_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки поставщика к документу. Получить можно методом catalog.documentcontractor.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки поставщика к документу. Получить можно методом catalog.documentcontractor.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.getFields": { "post": { "summary": "Получить описание полей привязки поставщика к документу складского учета catalog.documentcontractor.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.documentcontractor.getFields` возвращает описание полей для привязки поставщика, контакта или компании к документу складского учета.", "operationId": "catalog_documentcontractor_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.list": { "post": { "summary": "Получить список привязок поставщиков к документам catalog.documentcontractor.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.documentcontractor.list` возвращает список привязок поставщиков к документам складского учета. По умолчанию к запросу добавляются фильтры, ограничивающие выборку правами текущего пользователя.", "operationId": "catalog_documentcontractor_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/documentcontractor/catalog-documentcontractor-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей catalog_documentcontractor, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных документов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей catalog_documentcontractor, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных документов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.enum.getRoundTypes": { "post": { "summary": "Получить список типов округления catalog.enum.getRoundTypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.enum.getRoundTypes` возвращает список типов округления, доступных в каталоге.", "operationId": "catalog_enum_getRoundTypes", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/enum/catalog-enum-get-round-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.enum.getStoreDocumentTypes": { "post": { "summary": "Получить типы документов складского учета catalog.enum.getStoreDocumentTypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.enum.getStoreDocumentTypes` возвращает типы документов складского учета, доступные для REST.", "operationId": "catalog_enum_getStoreDocumentTypes", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/enum/catalog-enum-get-store-document-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.field.get": { "post": { "summary": "Получить поле наценки catalog.extra.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_extra_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/extra/catalog-extra-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.field.list": { "post": { "summary": "Получить список полей наценки v 3.0 catalog.extra.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_extra_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/extra/catalog-extra-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.get": { "post": { "summary": "Получить значения полей наценки по идентификатору v 3.0 catalog.extra.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_extra_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/extra/catalog-extra-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор наценки." }, "select": { "type": "array", "items": {}, "description": "| Массив полей наценки, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор наценки." }, "select": { "type": "array", "items": {}, "description": "| Массив полей наценки, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.getFields": { "post": { "summary": "Получить поля наценки catalog.extra.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.extra.getFields` возвращает описание полей наценки: тип, обязательность и доступность для изменения.", "operationId": "catalog_extra_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/extra/catalog-extra-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.list": { "post": { "summary": "Получить список наценок v 3.0 catalog.extra.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_extra_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/extra/catalog-extra-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей наценки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество наценок на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество наценок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей наценки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество наценок на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество наценок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.add": { "post": { "summary": "Добавить единицу измерения v 3.0 catalog.measure.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой единицы измерения. Описание полей ||" }, "code": { "type": "integer", "description": "| Код единицы измерения. Значение должно быть уникальным: если единица с таким кодом уже есть, метод вернет ошибку." }, "measureTitle": { "type": "string", "description": "| Название единицы измерения ||" }, "symbol": { "type": "string", "description": "| Условное обозначение ||" }, "symbolIntl": { "type": "string", "description": "| Международное условное обозначение ||" }, "symbolLetterIntl": { "type": "string", "description": "| Международное кодовое буквенное обозначение ||" }, "isDefault": { "type": "boolean", "description": "| Признак единицы измерения по умолчанию. Такая единица автоматически выбирается в карточке нового товара." } }, "required": [ "fields", "code", "measureTitle" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой единицы измерения. Описание полей ||" }, "code": { "type": "integer", "description": "| Код единицы измерения. Значение должно быть уникальным: если единица с таким кодом уже есть, метод вернет ошибку." }, "measureTitle": { "type": "string", "description": "| Название единицы измерения ||" }, "symbol": { "type": "string", "description": "| Условное обозначение ||" }, "symbolIntl": { "type": "string", "description": "| Международное условное обозначение ||" }, "symbolLetterIntl": { "type": "string", "description": "| Международное кодовое буквенное обозначение ||" }, "isDefault": { "type": "boolean", "description": "| Признак единицы измерения по умолчанию. Такая единица автоматически выбирается в карточке нового товара." } }, "required": [ "fields", "code", "measureTitle" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.delete": { "post": { "summary": "Удалить единицу измерения v 3.0 catalog.measure.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения, которую нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения, которую нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.field.get": { "post": { "summary": "Получить поле единицы измерения catalog.measure.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.field.list": { "post": { "summary": "Получить список полей единицы измерения v 3.0 catalog.measure.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.get": { "post": { "summary": "Получить информацию о единице измерения по идентификатору v 3.0 catalog.measure.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "select": { "type": "array", "items": {}, "description": "| Массив полей единицы измерения, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "select": { "type": "array", "items": {}, "description": "| Массив полей единицы измерения, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.getFields": { "post": { "summary": "Получить доступные поля единиц измерения catalog.measure.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.measure.getFields` возвращает доступные поля единиц измерения.", "operationId": "catalog_measure_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.list": { "post": { "summary": "Получить список единиц измерения v 3.0 catalog.measure.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей единицы измерения, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"code\",\"in\",[796,166]]]`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"code\":\"DESC\"}`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество единиц измерения на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) * limit`. Если передан `page`, значение `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить от начала списка." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей единицы измерения, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"code\",\"in\",[796,166]]]`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"code\":\"DESC\"}`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество единиц измерения на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) * limit`. Если передан `page`, значение `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить от начала списка." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.update": { "post": { "summary": "Обновить единицу измерения v 3.0 catalog.measure.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_measure_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/measure/catalog-measure-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "fields": { "type": "object", "description": "| Объект с полями единицы измерения, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "code": { "type": "integer", "description": "| Код единицы измерения. Значение должно быть уникальным: если код занят другой единицей, метод вернет ошибку ||" }, "measureTitle": { "type": "string", "description": "| Название единицы измерения ||" }, "symbol": { "type": "string", "description": "| Условное обозначение ||" }, "symbolIntl": { "type": "string", "description": "| Международное условное обозначение ||" }, "symbolLetterIntl": { "type": "string", "description": "| Международное кодовое буквенное обозначение ||" }, "isDefault": { "type": "boolean", "description": "| Признак единицы измерения по умолчанию. Такая единица автоматически выбирается в карточке нового товара." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "fields": { "type": "object", "description": "| Объект с полями единицы измерения, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "code": { "type": "integer", "description": "| Код единицы измерения. Значение должно быть уникальным: если код занят другой единицей, метод вернет ошибку ||" }, "measureTitle": { "type": "string", "description": "| Название единицы измерения ||" }, "symbol": { "type": "string", "description": "| Условное обозначение ||" }, "symbolIntl": { "type": "string", "description": "| Международное условное обозначение ||" }, "symbolLetterIntl": { "type": "string", "description": "| Международное кодовое буквенное обозначение ||" }, "isDefault": { "type": "boolean", "description": "| Признак единицы измерения по умолчанию. Такая единица автоматически выбирается в карточке нового товара." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.add": { "post": { "summary": "Добавить цену товара v 3.0 catalog.price.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой цены. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации." }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "price": { "type": "number", "format": "double", "description": "| Цена. Отрицательное значение вызывает ошибку ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Не длиннее трех символов." }, "extraId": { "type": "integer", "description": "| Идентификатор наценки." }, "quantityFrom": { "type": "integer", "description": "| Нижняя граница диапазона количества товара, для которого действует цена. `0` — без нижней границы." }, "quantityTo": { "type": "integer", "description": "| Верхняя граница диапазона количества товара, для которого действует цена. `0` — без верхней границы ||" } }, "required": [ "fields", "productId", "catalogGroupId", "price", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой цены. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации." }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "price": { "type": "number", "format": "double", "description": "| Цена. Отрицательное значение вызывает ошибку ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Не длиннее трех символов." }, "extraId": { "type": "integer", "description": "| Идентификатор наценки." }, "quantityFrom": { "type": "integer", "description": "| Нижняя граница диапазона количества товара, для которого действует цена. `0` — без нижней границы." }, "quantityTo": { "type": "integer", "description": "| Верхняя граница диапазона количества товара, для которого действует цена. `0` — без верхней границы ||" } }, "required": [ "fields", "productId", "catalogGroupId", "price", "currency" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.delete": { "post": { "summary": "Удалить цену товара v 3.0 catalog.price.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.field.get": { "post": { "summary": "Получить поле цены catalog.price.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.field.list": { "post": { "summary": "Получить список полей цены v 3.0 catalog.price.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.get": { "post": { "summary": "Получить цену товара по идентификатору v 3.0 catalog.price.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." }, "select": { "type": "array", "items": {}, "description": "| Массив полей цены, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." }, "select": { "type": "array", "items": {}, "description": "| Массив полей цены, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.getFields": { "post": { "summary": "Получить поля цены catalog.price.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.price.getFields` возвращает описание полей цены товара: тип, обязательность и доступность для изменения.", "operationId": "catalog_price_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.list": { "post": { "summary": "Получить список цен по фильтру v 3.0 catalog.price.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей цены, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"productId\",\"=\",7525]]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество цен на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`." }, "offset": { "type": "integer", "description": "| Количество цен, которые нужно пропустить от начала списка." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей цены, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"productId\",\"=\",7525]]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество цен на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`." }, "offset": { "type": "integer", "description": "| Количество цен, которые нужно пропустить от начала списка." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.modify": { "post": { "summary": "Обновить коллекцию цен товара catalog.price.modify", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.price.modify` изменяет коллекцию цен товара. Позволяет добавлять, обновлять и удалять разные цены товара за один запрос.", "operationId": "catalog_price_modify", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-modify.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными для модификации цен (подробное описание) ||" }, "product": { "type": "object", "description": "| Данные товара и его цен (подробное описание) ||" }, "id": { "type": "string", "description": "| Идентификатор товара, можно получить методами catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "prices": { "type": "array", "items": {}, "description": "| Массив цен товара (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, можно получить методом catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Значение цены ||" }, "currency": { "type": "string", "description": "| Идентификатор валюты, можно получить методом crm.currency.list ||" } }, "required": [ "fields", "product", "id", "prices", "catalogGroupId", "price", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными для модификации цен (подробное описание) ||" }, "product": { "type": "object", "description": "| Данные товара и его цен (подробное описание) ||" }, "id": { "type": "string", "description": "| Идентификатор товара, можно получить методами catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "prices": { "type": "array", "items": {}, "description": "| Массив цен товара (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, можно получить методом catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Значение цены ||" }, "currency": { "type": "string", "description": "| Идентификатор валюты, можно получить методом crm.currency.list ||" } }, "required": [ "fields", "product", "id", "prices", "catalogGroupId", "price", "currency" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.update": { "post": { "summary": "Изменить цену товара v 3.0 catalog.price.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_price_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price/catalog-price-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." }, "fields": { "type": "object", "description": "| Объект с полями цены, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "price": { "type": "number", "format": "double", "description": "| Цена. Отрицательное значение вызывает ошибку ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Не длиннее трех символов." }, "extraId": { "type": "integer", "description": "| Идентификатор наценки." }, "quantityFrom": { "type": "integer", "description": "| Нижняя граница диапазона количества товара. `0` — без нижней границы." }, "quantityTo": { "type": "integer", "description": "| Верхняя граница диапазона количества товара. `0` — без верхней границы ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цены." }, "fields": { "type": "object", "description": "| Объект с полями цены, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "price": { "type": "number", "format": "double", "description": "| Цена. Отрицательное значение вызывает ошибку ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Не длиннее трех символов." }, "extraId": { "type": "integer", "description": "| Идентификатор наценки." }, "quantityFrom": { "type": "integer", "description": "| Нижняя граница диапазона количества товара. `0` — без нижней границы." }, "quantityTo": { "type": "integer", "description": "| Верхняя граница диапазона количества товара. `0` — без верхней границы ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.add": { "post": { "summary": "Создать тип цены catalog.priceType.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.add` добавляет новый тип цены.", "operationId": "catalog_priceType_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа цены (подробное описание) ||" }, "base": { "type": "string", "description": "| Является ли тип цены базовым. Возможные значения:" }, "sort": { "type": "integer", "description": "| Сортировка." }, "xmlId": { "type": "string", "description": "| Внешний код." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа цены (подробное описание) ||" }, "base": { "type": "string", "description": "| Является ли тип цены базовым. Возможные значения:" }, "sort": { "type": "integer", "description": "| Сортировка." }, "xmlId": { "type": "string", "description": "| Внешний код." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.delete": { "post": { "summary": "Удалить тип цены catalog.priceType.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.delete` удаляет тип цены.", "operationId": "catalog_priceType_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.get": { "post": { "summary": "Получить значения полей типа цены catalog.priceType.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.get` возвращает информацию о типе цены по его идентификатору.", "operationId": "catalog_priceType_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.getFields": { "post": { "summary": "Получить поля типа цены catalog.priceType.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.getFields` возвращает описание полей типа цены.", "operationId": "catalog_priceType_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.list": { "post": { "summary": "Получить список типов цен по фильтру catalog.priceType.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.list` возвращает список типов цен по фильтру.", "operationId": "catalog_priceType_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_price_type)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных типов цен в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных типов цен в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_price_type)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных типов цен в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных типов цен в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.update": { "post": { "summary": "Обновить тип цены catalog.priceType.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceType.update` изменяет значения полей типа цены.", "operationId": "catalog_priceType_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." }, "fields": { "type": "object", "description": "| Объект с полями типа цены, которые нужно изменить (подробное описание)." }, "base": { "type": "string", "description": "| Является ли тип цены базовым. Возможные значения:" }, "sort": { "type": "integer", "description": "| Сортировка. Значение, которое не является числом, метод сохраняет как `100` без ошибки ||" }, "xmlId": { "type": "string", "description": "| Внешний код." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа цены." }, "fields": { "type": "object", "description": "| Объект с полями типа цены, которые нужно изменить (подробное описание)." }, "base": { "type": "string", "description": "| Является ли тип цены базовым. Возможные значения:" }, "sort": { "type": "integer", "description": "| Сортировка. Значение, которое не является числом, метод сохраняет как `100` без ошибки ||" }, "xmlId": { "type": "string", "description": "| Внешний код." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.add": { "post": { "summary": "Добавить привязку типа цен к группе покупателей catalog.priceTypeGroup.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeGroup.add` добавляет привязку типа цены к группе покупателей.", "operationId": "catalog_priceTypeGroup_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки типа цены к группе покупателей (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены. Можно получить методом catalog.priceType.list ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы покупателей ||" }, "access": { "type": "string", "maxLength": 1, "description": "| Тип доступа к цене. Возможные значения:" } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки типа цены к группе покупателей (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены. Можно получить методом catalog.priceType.list ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы покупателей ||" }, "access": { "type": "string", "maxLength": 1, "description": "| Тип доступа к цене. Возможные значения:" } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.delete": { "post": { "summary": "Удалить привязку типа цены к группе покупателей catalog.priceTypeGroup.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeGroup.delete` удаляет привязку типа цены к группе покупателей по идентификатору.", "operationId": "catalog_priceTypeGroup_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки типа цены к группе покупателей." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки типа цены к группе покупателей." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.getFields": { "post": { "summary": "Получить поля привязки типов цен к группам покупателей catalog.priceTypeGroup.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeGroup.getFields` возвращает описание полей привязки типов цен к группам покупателей.", "operationId": "catalog_priceTypeGroup_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.list": { "post": { "summary": "Получить список привязок типов цен к группам покупателей catalog.priceTypeGroup.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeGroup.list` возвращает список привязок типов цен к группам покупателей.", "operationId": "catalog_priceTypeGroup_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей catalog_price_type_group, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей catalog_price_type_group, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.add": { "post": { "summary": "Добавить перевод названия типа цены catalog.priceTypeLang.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.add` добавляет новый перевод названия типа цены.", "operationId": "catalog_priceTypeLang_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового перевода (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Идентификатор языка." } }, "required": [ "fields", "catalogGroupId", "lang" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового перевода (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Идентификатор языка." } }, "required": [ "fields", "catalogGroupId", "lang" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.delete": { "post": { "summary": "Удалить перевод названия типа цены catalog.priceTypeLang.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.delete` удаляет перевод названия типа цены по его идентификатору.", "operationId": "catalog_priceTypeLang_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.get": { "post": { "summary": "Получить значения полей перевода названия типа цены catalog.priceTypeLang.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.get` возвращает информацию о переводе названия типа цены по его идентификатору.", "operationId": "catalog_priceTypeLang_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.getFields": { "post": { "summary": "Получить поля перевода названия типа цены catalog.priceTypeLang.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.getFields` возвращает описание полей перевода названия типа цены.", "operationId": "catalog_priceTypeLang_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.getLanguages": { "post": { "summary": "Получить доступные для перевода языки catalog.priceTypeLang.getLanguages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.getLanguages` возвращает список доступных для перевода языков.", "operationId": "catalog_priceTypeLang_getLanguages", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.list": { "post": { "summary": "Получить список переводов названий типов цен по фильтру catalog.priceTypeLang.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.list` возвращает список переводов названий типов цен по фильтру.", "operationId": "catalog_priceTypeLang_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных переводов названий типов цен в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных переводов названий типов цен в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.update": { "post": { "summary": "Изменить перевод названия типа цены catalog.priceTypeLang.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.priceTypeLang.update` изменяет перевод названия типа цены по его идентификатору.", "operationId": "catalog_priceTypeLang_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." }, "fields": { "type": "object", "description": "| Объект с полями перевода, которые нужно изменить (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Идентификатор языка." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор перевода названия типа цены." }, "fields": { "type": "object", "description": "| Объект с полями перевода, которые нужно изменить (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Идентификатор языка." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.add": { "post": { "summary": "Создать тип цены v 3.0 catalog.pricetype.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа цены. Описание полей ||" }, "base": { "type": "boolean", "description": "| Признак базового типа цены." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации." }, "xmlId": { "type": "string", "description": "| Внешний код типа цены. Можно использовать для синхронизации с внешней системой ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа цены. Описание полей ||" }, "base": { "type": "boolean", "description": "| Признак базового типа цены." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации." }, "xmlId": { "type": "string", "description": "| Внешний код типа цены. Можно использовать для синхронизации с внешней системой ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.delete": { "post": { "summary": "Удалить тип цены v 3.0 catalog.pricetype.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.field.get": { "post": { "summary": "Получить поле типа цены catalog.pricetype.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.field.list": { "post": { "summary": "Получить список полей типа цены v 3.0 catalog.pricetype.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.get": { "post": { "summary": "Получить значения полей типа цены v 3.0 catalog.pricetype.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." }, "select": { "type": "array", "items": {}, "description": "| Массив полей типа цены, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." }, "select": { "type": "array", "items": {}, "description": "| Массив полей типа цены, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.group.add": { "post": { "summary": "Добавить привязку типа цен к группе покупателей v 3.0 catalog.pricetype.group.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_group_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой привязки. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "groupId": { "type": "integer", "description": "| Идентификатор группы пользователей." }, "access": { "type": "string", "description": "| Тип доступа к цене." } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой привязки. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "groupId": { "type": "integer", "description": "| Идентификатор группы пользователей." }, "access": { "type": "string", "description": "| Тип доступа к цене." } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.group.delete": { "post": { "summary": "Удалить привязку типа цены к группе покупателей v 3.0 catalog.pricetype.group.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_group_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор привязки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор привязки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.group.field.get": { "post": { "summary": "Получить поле привязки типа цены к группе покупателей catalog.pricetype.group.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_group_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.group.field.list": { "post": { "summary": "Получить список полей привязки типа цены к группе покупателей v 3.0 catalog.pricetype.group.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_group_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.add": { "post": { "summary": "Добавить перевод названия типа цены v 3.0 catalog.pricetype.lang.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового перевода. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Код языка, например `en` или `de`." } }, "required": [ "fields", "catalogGroupId", "lang" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового перевода. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены." }, "lang": { "type": "string", "description": "| Код языка, например `en` или `de`." } }, "required": [ "fields", "catalogGroupId", "lang" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.delete": { "post": { "summary": "Удалить перевод названия типа цены v 3.0 catalog.pricetype.lang.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор перевода." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор перевода." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.field.get": { "post": { "summary": "Получить поле перевода названия типа цены catalog.pricetype.lang.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.field.list": { "post": { "summary": "Получить список полей перевода названия типа цены v 3.0 catalog.pricetype.lang.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.getlanguages": { "post": { "summary": "Получить доступные для перевода языки v 3.0 catalog.pricetype.lang.getlanguages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_getlanguages", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.lang.update": { "post": { "summary": "Изменить перевод названия типа цены v 3.0 catalog.pricetype.lang.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_pricetype_lang_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор перевода." }, "fields": { "type": "object", "description": "| Объект с полями перевода, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены. Перевод можно перенести к другому типу цены." }, "lang": { "type": "string", "description": "| Код языка, например `fr`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор перевода." }, "fields": { "type": "object", "description": "| Объект с полями перевода, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены. Перевод можно перенести к другому типу цены." }, "lang": { "type": "string", "description": "| Код языка, например `fr`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.list": { "post": { "summary": "Получить список типов цен по фильтру v 3.0 catalog.pricetype.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа цены, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество типов цен на странице. Значения больше `1000` уменьшаются до `1000`. Ноль вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit` ||" }, "offset": { "type": "integer", "description": "| Количество типов цен, которые нужно пропустить от начала списка." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа цены, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество типов цен на странице. Значения больше `1000` уменьшаются до `1000`. Ноль вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit` ||" }, "offset": { "type": "integer", "description": "| Количество типов цен, которые нужно пропустить от начала списка." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.pricetype.update": { "post": { "summary": "Обновить тип цены v 3.0 catalog.pricetype.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_pricetype_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/price-type/catalog-price-type-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." }, "fields": { "type": "object", "description": "| Объект с полями типа цены, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "base": { "type": "boolean", "description": "| Признак базового типа цены." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации ||" }, "xmlId": { "type": "string", "description": "| Внешний код типа цены ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор типа цены." }, "fields": { "type": "object", "description": "| Объект с полями типа цены, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "base": { "type": "boolean", "description": "| Признак базового типа цены." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации ||" }, "xmlId": { "type": "string", "description": "| Внешний код типа цены ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.add": { "post": { "summary": "Добавить товар v 3.0 catalog.product.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового товара. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать, совпадет с идентификатором товара ||" }, "active": { "type": "string", "description": "| Активность товара." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал товар. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил товар ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела. Идентификатор можно получить методом catalog.section.list ||" }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать товар, например `[41, 39]`. Основной раздел задайте в `iblockSectionId` ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| НДС включен в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальный штрихкод для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Режим количественного учета с учетом настроек модуля: `Y`, `N` или `D` ||" }, "paymentType": { "type": "string", "description": "| Тип оплаты. Используется только в коробочной версии для продажи контента ||" }, "subscribeRaw": { "type": "string", "description": "| Разрешение подписки с учетом настроек модуля: `Y`, `N` или `D` ||" }, "canBuyZeroRaw": { "type": "string", "description": "| Разрешение покупки при отсутствии товара с учетом настроек модуля: `Y`, `N` или `D` ||" }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `id` — идентификатор свойства, например `{\"PROPERTY_301\": \"TS-001\", \"PROPERTY_305\": [\"Хлопок\", \"Полиэстер\"]}`." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового товара. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать, совпадет с идентификатором товара ||" }, "active": { "type": "string", "description": "| Активность товара." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал товар. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил товар ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела. Идентификатор можно получить методом catalog.section.list ||" }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать товар, например `[41, 39]`. Основной раздел задайте в `iblockSectionId` ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| НДС включен в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальный штрихкод для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Режим количественного учета с учетом настроек модуля: `Y`, `N` или `D` ||" }, "paymentType": { "type": "string", "description": "| Тип оплаты. Используется только в коробочной версии для продажи контента ||" }, "subscribeRaw": { "type": "string", "description": "| Разрешение подписки с учетом настроек модуля: `Y`, `N` или `D` ||" }, "canBuyZeroRaw": { "type": "string", "description": "| Разрешение покупки при отсутствии товара с учетом настроек модуля: `Y`, `N` или `D` ||" }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `id` — идентификатор свойства, например `{\"PROPERTY_301\": \"TS-001\", \"PROPERTY_305\": [\"Хлопок\", \"Полиэстер\"]}`." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.delete": { "post": { "summary": "Удалить товар v 3.0 catalog.product.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара, который нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара, который нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.download": { "post": { "summary": "Скачать файлы товара v 3.0 catalog.product.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_download", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-download-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара." }, "fieldName": { "type": "string", "description": "| Поле товара, в котором хранится файл." }, "fileId": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара." }, "fieldName": { "type": "string", "description": "| Поле товара, в котором хранится файл." }, "fileId": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.field.get": { "post": { "summary": "Получить поле товара catalog.product.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.field.list": { "post": { "summary": "Получить список полей товара v 3.0 catalog.product.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.fields.getbyfilter": { "post": { "summary": "Получить поля товара по фильтру v 3.0 catalog.product.fields.getbyfilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_fields_getbyfilter", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-fields-get-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с идентификатором каталога. Описание параметра." }, "iblockId": { "type": "integer", "description": "| Идентификатор торгового каталога товаров. Ключ можно передать и в виде `IBLOCK_ID`." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с идентификатором каталога. Описание параметра." }, "iblockId": { "type": "integer", "description": "| Идентификатор торгового каталога товаров. Ключ можно передать и в виде `IBLOCK_ID`." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.get": { "post": { "summary": "Получить товар по идентификатору v 3.0 catalog.product.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей товара, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей товара, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.getFieldsByFilter": { "post": { "summary": "Получить поля товара по фильтру catalog.product.getFieldsByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.product.getFieldsByFilter` возвращает описание полей простого товара в указанном каталоге, включая свойства каталога.", "operationId": "catalog_product_getFieldsByFilter", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-get-fields-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с идентификатором каталога (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога товаров. Получить идентификатор можно методом catalog.catalog.list." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект с идентификатором каталога (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога товаров. Получить идентификатор можно методом catalog.catalog.list." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.add": { "post": { "summary": "Добавить изображение в товар v 3.0 catalog.product.image.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового изображения. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации." }, "type": { "type": "string", "description": "| Куда добавить изображение." }, "file": { "type": "object", "description": "| Файл изображения. Описание объекта ||" }, "upload": { "type": "object", "description": "| Данные загружаемого файла. Описание объекта ||" }, "data": { "type": "string", "description": "| Содержимое файла в формате Base64." }, "url": { "type": "string", "description": "| Публичная ссылка на файл. Битрикс24 скачает файл по ссылке." } }, "required": [ "fields", "productId", "type", "file", "upload" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового изображения. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации." }, "type": { "type": "string", "description": "| Куда добавить изображение." }, "file": { "type": "object", "description": "| Файл изображения. Описание объекта ||" }, "upload": { "type": "object", "description": "| Данные загружаемого файла. Описание объекта ||" }, "data": { "type": "string", "description": "| Содержимое файла в формате Base64." }, "url": { "type": "string", "description": "| Публичная ссылка на файл. Битрикс24 скачает файл по ссылке." } }, "required": [ "fields", "productId", "type", "file", "upload" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.delete": { "post": { "summary": "Удалить изображение из товара v 3.0 catalog.product.image.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор изображения, которое нужно удалить." }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации, из которого нужно удалить изображение." } }, "required": [ "id", "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор изображения, которое нужно удалить." }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации, из которого нужно удалить изображение." } }, "required": [ "id", "productId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.field.get": { "post": { "summary": "Получить поле изображения товара catalog.product.image.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.field.list": { "post": { "summary": "Получить список полей изображения товара v 3.0 catalog.product.image.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.get": { "post": { "summary": "Получить информацию об изображении товара v 3.0 catalog.product.image.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор изображения." }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации, к которому относится изображение." }, "select": { "type": "array", "items": {}, "description": "| Список полей изображения, которые нужно вернуть в ответе." } }, "required": [ "id", "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор изображения." }, "productId": { "type": "integer", "description": "| Идентификатор товара или вариации, к которому относится изображение." }, "select": { "type": "array", "items": {}, "description": "| Список полей изображения, которые нужно вернуть в ответе." } }, "required": [ "id", "productId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.image.list": { "post": { "summary": "Получить список изображений товара v 3.0 catalog.product.image.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_image_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Список полей изображения, которые нужно вернуть в ответе." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество изображений на странице. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Количество изображений, которые нужно пропустить ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Список полей изображения, которые нужно вернуть в ответе." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество изображений на странице. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Количество изображений, которые нужно пропустить ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.list": { "post": { "summary": "Получить список товаров по фильтру v 3.0 catalog.product.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей товара, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество товаров на странице. Значения больше `50` уменьшаются до `50`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Количество товаров, которые нужно пропустить. Значение должно быть кратно `limit`, иначе метод вернет ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей товара, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество товаров на странице. Значения больше `50` уменьшаются до `50`, значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Количество товаров, которые нужно пропустить. Значение должно быть кратно `limit`, иначе метод вернет ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.add": { "post": { "summary": "Добавить вариацию товара v 3.0 catalog.product.offer.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой вариации. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога вариаций." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение можно передать строкой, числом или объектом `{\"VALUE\": ...}`, для множественного свойства — массивом таких значений." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой вариации. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога вариаций." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение можно передать строкой, числом или объектом `{\"VALUE\": ...}`, для множественного свойства — массивом таких значений." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.delete": { "post": { "summary": "Удалить вариацию товара v 3.0 catalog.product.offer.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации, которую нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации, которую нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.download": { "post": { "summary": "Скачать файлы вариации товара v 3.0 catalog.product.offer.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_download", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-download-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор вариации." }, "fieldName": { "type": "string", "description": "| Имя поля, в котором хранится файл, в верхнем регистре через подчеркивание." }, "fileId": { "type": "integer", "description": "| Идентификатор файла. Его возвращает метод catalog.product.offer.get в полях `previewPicture`, `detailPicture` или в значении файлового свойства в `properties` ||" } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор вариации." }, "fieldName": { "type": "string", "description": "| Имя поля, в котором хранится файл, в верхнем регистре через подчеркивание." }, "fileId": { "type": "integer", "description": "| Идентификатор файла. Его возвращает метод catalog.product.offer.get в полях `previewPicture`, `detailPicture` или в значении файлового свойства в `properties` ||" } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.field.get": { "post": { "summary": "Получить поле вариации товара catalog.product.offer.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.field.list": { "post": { "summary": "Получить список полей вариации товара v 3.0 catalog.product.offer.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.get": { "post": { "summary": "Получить значения полей вариации товара v 3.0 catalog.product.offer.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации." }, "select": { "type": "array", "items": {}, "description": "| Массив полей вариации, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации." }, "select": { "type": "array", "items": {}, "description": "| Массив полей вариации, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.getFieldsByFilter": { "post": { "summary": "Получить поля вариации товара по фильтру catalog.product.offer.getFieldsByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.product.offer.getFieldsByFilter` возвращает описание полей и свойств вариации для указанного каталога вариаций: тип, обязательность и доступность для изменения.", "operationId": "catalog_product_offer_getFieldsByFilter", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-get-fields-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр с идентификатором каталога вариаций (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор инфоблока каталога вариаций." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр с идентификатором каталога вариаций (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор инфоблока каталога вариаций." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.list": { "post": { "summary": "Получить список вариаций товара v 3.0 catalog.product.offer.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей вариации, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Должно быть кратно `limit` ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей вариации, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Должно быть кратно `limit` ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.update": { "post": { "summary": "Обновить поля вариации товара v 3.0 catalog.product.offer.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_offer_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/offer/catalog-product-offer-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации." }, "fields": { "type": "object", "description": "| Объект с полями вариации, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога вариаций. Изменить инфоблок нельзя: можно передать только текущее значение ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение передавайте объектом `{\"VALUE\": ...}` или массивом таких объектов. Значение строкой или числом метод не сохраняет и очищает свойство." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор вариации." }, "fields": { "type": "object", "description": "| Объект с полями вариации, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога вариаций. Изменить инфоблок нельзя: можно передать только текущее значение ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас метод отклоняет это поле в любом формате даты с ошибкой валидации запроса, поэтому не передавайте его ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение передавайте объектом `{\"VALUE\": ...}` или массивом таких объектов. Значение строкой или числом метод не сохраняет и очищает свойство." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.add": { "post": { "summary": "Добавить свойство товара или вариации v 3.0 catalog.product.property.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового свойства. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор торгового каталога, в который нужно добавить свойство. Для свойства товара передайте каталог товаров, для свойства вариации — каталог вариаций." }, "code": { "type": "string", "description": "| Символьный код свойства, например `MATERIAL`. Метод не проверяет уникальность кода ||" }, "sort": { "type": "integer", "description": "| Сортировка." }, "multiple": { "type": "string", "description": "| Множественное свойство." }, "isRequired": { "type": "string", "description": "| Обязательное свойство." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового свойства. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор торгового каталога, в который нужно добавить свойство. Для свойства товара передайте каталог товаров, для свойства вариации — каталог вариаций." }, "code": { "type": "string", "description": "| Символьный код свойства, например `MATERIAL`. Метод не проверяет уникальность кода ||" }, "sort": { "type": "integer", "description": "| Сортировка." }, "multiple": { "type": "string", "description": "| Множественное свойство." }, "isRequired": { "type": "string", "description": "| Обязательное свойство." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.field.get": { "post": { "summary": "Получить поле свойства товара catalog.product.property.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.field.list": { "post": { "summary": "Получить список полей свойства товара v 3.0 catalog.product.property.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.type.field.get": { "post": { "summary": "Получить поле типа свойства товара catalog.product.property.type.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_type_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-type-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.type.field.list": { "post": { "summary": "Получить список полей типа свойства товара catalog.product.property.type.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_type_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-type-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.property.type.list": { "post": { "summary": "Получить список типов свойств товаров catalog.product.property.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_property_type_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей типа свойства, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей типа свойства, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.add": { "post": { "summary": "Добавить услугу v 3.0 catalog.product.service.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой услуги. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога. Изменить после создания нельзя." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать, Битрикс24 запишет в поле идентификатор услуги ||" }, "active": { "type": "string", "description": "| Активность услуги." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал услугу." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил услугу." }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601, например `2026-11-01T10:00:00+03:00` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела каталога." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать услугу, например `[31, 45]`. Если `iblockSectionId` не передан, основным становится первый раздел из массива." }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешение покупки при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешение подписки на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена ||" }, "purchasingCurrency": { "type": "string", "description": "| Код валюты закупочной цены, например `RUB`." }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется для продажи контента в коробочной версии ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты." }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется для продажи контента в коробочной версии ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа." }, "quantityTraceRaw": { "type": "string", "description": "| Сохраненное значение режима количественного учета." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Сохраненное значение разрешения подписки." }, "canBuyZeroRaw": { "type": "string", "description": "| Сохраненное значение разрешения покупки при отсутствии товара." }, "properties": { "type": "object", "description": "| Значения свойств услуги. Ключи — `PROPERTY_{id}`, где `{id}` — идентификатор свойства, например `{\"PROPERTY_301\": \"SRV-001\"}`. Для множественного свойства передайте массив значений." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой услуги. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога. Изменить после создания нельзя." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать, Битрикс24 запишет в поле идентификатор услуги ||" }, "active": { "type": "string", "description": "| Активность услуги." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал услугу." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил услугу." }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601, например `2026-11-01T10:00:00+03:00` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела каталога." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать услугу, например `[31, 45]`. Если `iblockSectionId` не передан, основным становится первый раздел из массива." }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешение покупки при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешение подписки на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена ||" }, "purchasingCurrency": { "type": "string", "description": "| Код валюты закупочной цены, например `RUB`." }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется для продажи контента в коробочной версии ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты." }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется для продажи контента в коробочной версии ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа." }, "quantityTraceRaw": { "type": "string", "description": "| Сохраненное значение режима количественного учета." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Сохраненное значение разрешения подписки." }, "canBuyZeroRaw": { "type": "string", "description": "| Сохраненное значение разрешения покупки при отсутствии товара." }, "properties": { "type": "object", "description": "| Значения свойств услуги. Ключи — `PROPERTY_{id}`, где `{id}` — идентификатор свойства, например `{\"PROPERTY_301\": \"SRV-001\"}`. Для множественного свойства передайте массив значений." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.delete": { "post": { "summary": "Удалить услугу v 3.0 catalog.product.service.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги, которую нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги, которую нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.download": { "post": { "summary": "Скачать файлы услуги v 3.0 catalog.product.service.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_download", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-download-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание параметра ||" }, "productId": { "type": "integer", "description": "| Идентификатор услуги." }, "fieldName": { "type": "string", "description": "| Имя поля с файлом в верхнем регистре." }, "fileId": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание параметра ||" }, "productId": { "type": "integer", "description": "| Идентификатор услуги." }, "fieldName": { "type": "string", "description": "| Имя поля с файлом в верхнем регистре." }, "fileId": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.field.get": { "post": { "summary": "Получить поле услуги catalog.product.service.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.field.list": { "post": { "summary": "Получить список полей услуги v 3.0 catalog.product.service.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.get": { "post": { "summary": "Получить значения полей услуги v 3.0 catalog.product.service.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги." }, "select": { "type": "array", "items": {}, "description": "| Массив полей услуги, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги." }, "select": { "type": "array", "items": {}, "description": "| Массив полей услуги, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.getFieldsByFilter": { "post": { "summary": "Получить поля услуги по фильтру catalog.product.service.getFieldsByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.product.service.getFieldsByFilter` возвращает описание полей услуги в указанном каталоге, включая свойства каталога.", "operationId": "catalog_product_service_getFieldsByFilter", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-get-fields-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр для получения всех полей услуги (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога товаров. Получить идентификатор можно методом catalog.catalog.list." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр для получения всех полей услуги (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога товаров. Получить идентификатор можно методом catalog.catalog.list." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.list": { "post": { "summary": "Получить список услуг v 3.0 catalog.product.service.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей услуги, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество услуг на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Сколько записей пропустить. Значение должно быть кратно `limit` ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей услуги, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество услуг на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Сколько записей пропустить. Значение должно быть кратно `limit` ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.update": { "post": { "summary": "Обновить поля услуги v 3.0 catalog.product.service.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_service_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/service/catalog-product-service-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги." }, "fields": { "type": "object", "description": "| Объект с полями услуги, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код ||" }, "active": { "type": "string", "description": "| Активность услуги." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал услугу." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил услугу." }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601, например `2026-11-01T10:00:00+03:00` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела каталога." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать услугу, например `[31, 45]`. Если `iblockSectionId` не передан, основным становится первый раздел из массива." }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешение покупки при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешение подписки на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена ||" }, "purchasingCurrency": { "type": "string", "description": "| Код валюты закупочной цены, например `RUB`." }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется для продажи контента в коробочной версии ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты." }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется для продажи контента в коробочной версии ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа." }, "quantityTraceRaw": { "type": "string", "description": "| Сохраненное значение режима количественного учета." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Сохраненное значение разрешения подписки." }, "canBuyZeroRaw": { "type": "string", "description": "| Сохраненное значение разрешения покупки при отсутствии товара." }, "properties": { "type": "object", "description": "| Значения свойств услуги. Ключи — `PROPERTY_{id}`, где `{id}` — идентификатор свойства." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор услуги." }, "fields": { "type": "object", "description": "| Объект с полями услуги, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код ||" }, "active": { "type": "string", "description": "| Активность услуги." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал услугу." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил услугу." }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601, например `2026-11-01T10:00:00+03:00` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Объект в формате `{\"fileData\": [\"имя_файла.png\", \"содержимое в base64\"]}`." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела каталога." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать услугу, например `[31, 45]`. Если `iblockSectionId` не передан, основным становится первый раздел из массива." }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешение покупки при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешение подписки на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена ||" }, "purchasingCurrency": { "type": "string", "description": "| Код валюты закупочной цены, например `RUB`." }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения." }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется для продажи контента в коробочной версии ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты." }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется для продажи контента в коробочной версии ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа." }, "quantityTraceRaw": { "type": "string", "description": "| Сохраненное значение режима количественного учета." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Сохраненное значение разрешения подписки." }, "canBuyZeroRaw": { "type": "string", "description": "| Сохраненное значение разрешения покупки при отсутствии товара." }, "properties": { "type": "object", "description": "| Значения свойств услуги. Ключи — `PROPERTY_{id}`, где `{id}` — идентификатор свойства." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.add": { "post": { "summary": "Добавить головной товар v 3.0 catalog.product.sku.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового головного товара. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога товаров." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601 ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение можно передать строкой, числом или объектом `{\"VALUE\": ...}`, для множественного свойства — массивом таких значений." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового головного товара. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога товаров." }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601 ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств товара. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение можно передать строкой, числом или объектом `{\"VALUE\": ...}`, для множественного свойства — массивом таких значений." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.delete": { "post": { "summary": "Удалить головной товар v 3.0 catalog.product.sku.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара, который нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара, который нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.download": { "post": { "summary": "Скачать файлы головного товара v 3.0 catalog.product.sku.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_download", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-download-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор головного товара." }, "fieldName": { "type": "string", "description": "| Имя поля, в котором хранится файл, в верхнем регистре через подчеркивание." }, "fileId": { "type": "integer", "description": "| Идентификатор файла. Его возвращает метод catalog.product.sku.get в полях `previewPicture`, `detailPicture` или в значении файлового свойства в `properties` ||" } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами файла. Описание полей ||" }, "productId": { "type": "integer", "description": "| Идентификатор головного товара." }, "fieldName": { "type": "string", "description": "| Имя поля, в котором хранится файл, в верхнем регистре через подчеркивание." }, "fileId": { "type": "integer", "description": "| Идентификатор файла. Его возвращает метод catalog.product.sku.get в полях `previewPicture`, `detailPicture` или в значении файлового свойства в `properties` ||" } }, "required": [ "fields", "productId", "fieldName", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.field.get": { "post": { "summary": "Получить поле головного товара catalog.product.sku.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.field.list": { "post": { "summary": "Получить список полей головного товара v 3.0 catalog.product.sku.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.get": { "post": { "summary": "Получить значения полей головного товара v 3.0 catalog.product.sku.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей головного товара, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей головного товара, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.getFieldsByFilter": { "post": { "summary": "Получить поля головного товара по фильтру catalog.product.sku.getFieldsByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.product.sku.getFieldsByFilter` возвращает описание полей и свойств головного товара для указанного инфоблока каталога: тип, обязательность, доступность для изменения.", "operationId": "catalog_product_sku_getFieldsByFilter", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-get-fields-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр с идентификатором инфоблока каталога (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор инфоблока каталога товаров." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр с идентификатором инфоблока каталога (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор инфоблока каталога товаров." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.list": { "post": { "summary": "Получить список головных товаров v 3.0 catalog.product.sku.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей головного товара, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Должно быть кратно `limit` ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Синтаксис фильтра описан в обзоре REST 3.0." }, "select": { "type": "array", "items": {}, "description": "| Массив полей головного товара, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\": \"desc\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание объекта ||" }, "limit": { "type": "integer", "description": "| Количество записей на странице. Значения больше `50` уменьшаются до `50`. Значение `0` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1` ||" }, "offset": { "type": "integer", "description": "| Смещение от начала списка. Должно быть кратно `limit` ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.update": { "post": { "summary": "Обновить поля головного товара v 3.0 catalog.product.sku.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "catalog_product_sku_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/sku/catalog-product-sku-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара." }, "fields": { "type": "object", "description": "| Объект с полями головного товара, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога товаров. Изменить инфоблок нельзя: можно передать только текущее значение ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601 ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение передавайте объектом `{\"VALUE\": ...}` или массивом таких объектов. Значение строкой или числом метод не сохраняет и очищает текущее значение свойства без ошибки." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор головного товара." }, "fields": { "type": "object", "description": "| Объект с полями головного товара, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока каталога товаров. Изменить инфоблок нельзя: можно передать только текущее значение ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Если не передать при создании, совпадает с `id` ||" }, "active": { "type": "string", "description": "| Активность." }, "sort": { "type": "integer", "description": "| Сортировка." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал запись. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил запись. По умолчанию — текущий пользователь ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности в формате ISO 8601 ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности в формате ISO 8601 ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас метод не сохраняет значение поля, подробнее — в предупреждении ниже ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела." }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов всех разделов, к которым нужно привязать товар ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество ||" }, "quantityTrace": { "type": "string", "description": "| Количественный учет." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list ||" }, "vatIncluded": { "type": "string", "description": "| Включен ли НДС в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. Список валют можно получить методом crm.currency.list. При включенном складском учете значение не сохраняется ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальные штрихкоды для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Товар для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа: `Y` или `N`. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Количественный учет с учетом значения по умолчанию." }, "paymentType": { "type": "string", "description": "| Тип оплаты." }, "subscribeRaw": { "type": "string", "description": "| Подписка на товар с учетом значения по умолчанию." }, "canBuyZeroRaw": { "type": "string", "description": "| Покупка при отсутствии с учетом значения по умолчанию." }, "properties": { "type": "object", "description": "| Значения свойств, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `{id}` — идентификатор свойства. Значение передавайте объектом `{\"VALUE\": ...}` или массивом таких объектов. Значение строкой или числом метод не сохраняет и очищает текущее значение свойства без ошибки." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.type.field.get": { "post": { "summary": "Получить поле типа товара catalog.product.type.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_type_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-type-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.type.field.list": { "post": { "summary": "Получить список полей типа товара catalog.product.type.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_type_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-type-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.type.list": { "post": { "summary": "Получить список типов товаров catalog.product.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_type_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей типа, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.update": { "post": { "summary": "Обновить товар v 3.0 catalog.product.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_product_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product/catalog-product-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара." }, "fields": { "type": "object", "description": "| Объект с полями товара, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога. Изменить инфоблок товара нельзя: значение, отличное от текущего, вызывает ошибку ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Можно использовать для синхронизации с внешней системой ||" }, "active": { "type": "string", "description": "| Активность товара." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал товар. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил товар ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела. Идентификатор можно получить методом catalog.section.list ||" }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать товар, например `[41, 39]`. Основной раздел задайте в `iblockSectionId` ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list." }, "vatIncluded": { "type": "string", "description": "| НДС включен в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальный штрихкод для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Режим количественного учета с учетом настроек модуля: `Y`, `N` или `D` ||" }, "paymentType": { "type": "string", "description": "| Тип оплаты. Используется только в коробочной версии для продажи контента ||" }, "subscribeRaw": { "type": "string", "description": "| Разрешение подписки с учетом настроек модуля: `Y`, `N` или `D` ||" }, "canBuyZeroRaw": { "type": "string", "description": "| Разрешение покупки при отсутствии товара с учетом настроек модуля: `Y`, `N` или `D` ||" }, "properties": { "type": "object", "description": "| Значения свойств товара, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `id` — идентификатор свойства. Свойства, которые не переданы, не меняются." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара." }, "fields": { "type": "object", "description": "| Объект с полями товара, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога. Изменить инфоблок товара нельзя: значение, отличное от текущего, вызывает ошибку ||" }, "code": { "type": "string", "description": "| Символьный код ||" }, "xmlId": { "type": "string", "description": "| Внешний код. Можно использовать для синхронизации с внешней системой ||" }, "active": { "type": "string", "description": "| Активность товара." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал товар. Идентификатор можно получить методом user.get ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил товар ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Дата начала активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| Дата окончания активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только `null` ||" }, "previewText": { "type": "string", "description": "| Описание для анонса ||" }, "previewTextType": { "type": "string", "description": "| Тип описания для анонса." }, "previewPicture": { "type": "object", "description": "| Картинка для анонса. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "detailText": { "type": "string", "description": "| Детальное описание ||" }, "detailTextType": { "type": "string", "description": "| Тип детального описания." }, "detailPicture": { "type": "object", "description": "| Детальная картинка. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате `{\"fileData\": [\"имя.png\", \"base64\"]}` проходит проверку, но файл не сохраняется. Загрузите файл методом прежней версии catalog.product.update ||" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор основного раздела. Идентификатор можно получить методом catalog.section.list ||" }, "iblockSection": { "type": "array", "items": {}, "description": "| Массив идентификаторов разделов, к которым нужно привязать товар, например `[41, 39]`. Основной раздел задайте в `iblockSectionId` ||" }, "quantity": { "type": "number", "format": "double", "description": "| Доступное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityReserved": { "type": "number", "format": "double", "description": "| Зарезервированное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "quantityTrace": { "type": "string", "description": "| Режим количественного учета." }, "canBuyZero": { "type": "string", "description": "| Разрешить покупку при отсутствии товара." }, "subscribe": { "type": "string", "description": "| Разрешить подписку на товар." }, "vatId": { "type": "integer", "description": "| Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list." }, "vatIncluded": { "type": "string", "description": "| НДС включен в цену." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Закупочная цена. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "purchasingCurrency": { "type": "string", "description": "| Валюта закупочной цены, например `RUB`. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним ||" }, "barcodeMulti": { "type": "string", "description": "| Уникальный штрихкод для каждого экземпляра." }, "weight": { "type": "number", "format": "double", "description": "| Вес ||" }, "length": { "type": "number", "format": "double", "description": "| Длина ||" }, "width": { "type": "number", "format": "double", "description": "| Ширина ||" }, "height": { "type": "number", "format": "double", "description": "| Высота ||" }, "measure": { "type": "integer", "description": "| Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list ||" }, "recurSchemeLength": { "type": "integer", "description": "| Длина периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "recurSchemeType": { "type": "string", "description": "| Единица времени периода оплаты. Используется только в коробочной версии для продажи контента ||" }, "trialPriceId": { "type": "integer", "description": "| Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента ||" }, "withoutOrder": { "type": "string", "description": "| Продление без оформления заказа. Используется только в коробочной версии для продажи контента ||" }, "quantityTraceRaw": { "type": "string", "description": "| Режим количественного учета с учетом настроек модуля: `Y`, `N` или `D` ||" }, "paymentType": { "type": "string", "description": "| Тип оплаты. Используется только в коробочной версии для продажи контента ||" }, "subscribeRaw": { "type": "string", "description": "| Разрешение подписки с учетом настроек модуля: `Y`, `N` или `D` ||" }, "canBuyZeroRaw": { "type": "string", "description": "| Разрешение покупки при отсутствии товара с учетом настроек модуля: `Y`, `N` или `D` ||" }, "properties": { "type": "object", "description": "| Значения свойств товара, которые нужно изменить. Ключ — `PROPERTY_{id}`, где `id` — идентификатор свойства. Свойства, которые не переданы, не меняются." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.add": { "post": { "summary": "Добавить изображение в товар catalog.productImage.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productImage.add` добавляет изображение в товар, головной товар, вариацию или услугу.", "operationId": "catalog_productImage_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового изображения (подробное описание) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из двух элементов:" }, "productId": { "type": "string", "description": "\\|" }, "type": { "type": "string", "description": "| Тип изображения:" } }, "required": [ "fields", "fileContent", "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового изображения (подробное описание) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из двух элементов:" }, "productId": { "type": "string", "description": "\\|" }, "type": { "type": "string", "description": "| Тип изображения:" } }, "required": [ "fields", "fileContent", "productId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.delete": { "post": { "summary": "Удалить изображение из товара catalog.productImage.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productImage.delete` удаляет изображение из товара, головного товара, вариации или услуги.", "operationId": "catalog_productImage_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Идентификатор изображения. Изображение должно относиться к товару из `productId`." } }, "required": [ "productId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Идентификатор изображения. Изображение должно относиться к товару из `productId`." } }, "required": [ "productId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.get": { "post": { "summary": "Получить информацию об изображении товара catalog.productImage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productImage.get` возвращает информацию об изображении товара, головного товара, вариации или услуги.", "operationId": "catalog_productImage_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Идентификатор изображения. Изображение должно относиться к товару из `productId`." } }, "required": [ "productId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Идентификатор изображения. Изображение должно относиться к товару из `productId`." } }, "required": [ "productId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.getFields": { "post": { "summary": "Получить поля изображения товара catalog.productImage.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productImage.getFields` возвращает описание полей изображения товара: тип, обязательность и доступность для изменения.", "operationId": "catalog_productImage_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.list": { "post": { "summary": "Получить список изображений товара catalog.productImage.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productImage.list` возвращает все изображения товара, головного товара, вариации или услуги одним ответом, без постраничной навигации.", "operationId": "catalog_productImage_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-image/catalog-product-image-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть:" } }, "required": [ "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть:" } }, "required": [ "productId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.add": { "post": { "summary": "Добавить свойство товара или вариации catalog.productProperty.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.add` добавляет свойство товара или вариации.", "operationId": "catalog_productProperty_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового свойства (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога." }, "propertyType": { "type": "string", "description": "| Базовый тип свойства. Допустимые значения:" }, "active": { "type": "string", "maxLength": 1, "description": "| Признак активности. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Код свойства может состоять из латинских символов, цифр и знака подчеркивания. Первый символ не может быть цифрой ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства по умолчанию ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства. Значение должно соответствовать указанному `propertyType`." }, "rowCount": { "type": "integer", "description": "| Число строк поля ввода." }, "colCount": { "type": "integer", "description": "| Число колонок поля ввода." }, "listType": { "type": "string", "maxLength": 1, "description": "| Внешний вид списка. Допустимые значения:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Признак множественного значения. Допустимые значения:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства ||" }, "fileType": { "type": "string", "description": "| Список расширений файлов для свойства типа `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Число полей для ввода множественных значений ||" }, "linkIblockId": { "type": "string", "description": "| Идентификатор связанного инфоблока." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Признак хранения описания значения. Допустимые значения:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Признак участия в поиске. Допустимые значения:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Признак участия в фильтрации. Допустимые значения:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Признак обязательного значения. Допустимые значения:" }, "hint": { "type": "string", "description": "| Подсказка к полю ||" }, "userTypeSettings": { "type": "object", "description": "| Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений ||" } }, "required": [ "fields", "iblockId", "propertyType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового свойства (подробное описание) ||" }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога." }, "propertyType": { "type": "string", "description": "| Базовый тип свойства. Допустимые значения:" }, "active": { "type": "string", "maxLength": 1, "description": "| Признак активности. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Код свойства может состоять из латинских символов, цифр и знака подчеркивания. Первый символ не может быть цифрой ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства по умолчанию ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства. Значение должно соответствовать указанному `propertyType`." }, "rowCount": { "type": "integer", "description": "| Число строк поля ввода." }, "colCount": { "type": "integer", "description": "| Число колонок поля ввода." }, "listType": { "type": "string", "maxLength": 1, "description": "| Внешний вид списка. Допустимые значения:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Признак множественного значения. Допустимые значения:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства ||" }, "fileType": { "type": "string", "description": "| Список расширений файлов для свойства типа `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Число полей для ввода множественных значений ||" }, "linkIblockId": { "type": "string", "description": "| Идентификатор связанного инфоблока." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Признак хранения описания значения. Допустимые значения:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Признак участия в поиске. Допустимые значения:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Признак участия в фильтрации. Допустимые значения:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Признак обязательного значения. Допустимые значения:" }, "hint": { "type": "string", "description": "| Подсказка к полю ||" }, "userTypeSettings": { "type": "object", "description": "| Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений ||" } }, "required": [ "fields", "iblockId", "propertyType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.delete": { "post": { "summary": "Удалить свойство товаров или вариаций catalog.productProperty.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.delete` удаляет свойство товара или вариации.", "operationId": "catalog_productProperty_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.get": { "post": { "summary": "Получить значения полей свойства товаров или вариаций catalog.productProperty.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.get` возвращает значения полей свойства товара или вариации.", "operationId": "catalog_productProperty_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.getFields": { "post": { "summary": "Получить поля свойства товаров или вариаций catalog.productProperty.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.getFields` возвращает поля свойства товаров или вариаций.", "operationId": "catalog_productProperty_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.list": { "post": { "summary": "Получить список свойств товаров или вариаций catalog.productProperty.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.list` возвращает список свойств товаров и вариаций по фильтру.", "operationId": "catalog_productProperty_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.update": { "post": { "summary": "Изменить свойство товаров или вариаций catalog.productProperty.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productProperty.update` изменяет поля свойства товара или вариации.", "operationId": "catalog_productProperty_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." }, "fields": { "type": "object", "description": "| Объект с полями свойства, которые нужно изменить (подробное описание)." }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога." }, "propertyType": { "type": "string", "description": "| Базовый тип свойства. Допустимые значения описаны в методе catalog.productProperty.add." }, "active": { "type": "string", "maxLength": 1, "description": "| Признак активности. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Код свойства может состоять из латинских символов, цифр и знака подчеркивания. Первый символ не может быть цифрой ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства по умолчанию ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства. Значение должно подходить к `propertyType`, список значений описан в методе catalog.productProperty.add." }, "rowCount": { "type": "integer", "description": "| Число строк поля ввода ||" }, "colCount": { "type": "integer", "description": "| Число колонок поля ввода ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Внешний вид списка. Допустимые значения:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Признак множественного значения. Допустимые значения:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства ||" }, "fileType": { "type": "string", "description": "| Список расширений файлов для свойства типа `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Число полей для ввода множественных значений ||" }, "linkIblockId": { "type": "string", "description": "| Идентификатор связанного инфоблока." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Признак хранения описания значения. Допустимые значения:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Признак участия в поиске. Допустимые значения:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Признак участия в фильтрации. Допустимые значения:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Признак обязательного значения. Допустимые значения:" }, "hint": { "type": "string", "description": "| Подсказка к полю ||" }, "userTypeSettings": { "type": "object", "description": "| Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений." } }, "required": [ "id", "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства." }, "fields": { "type": "object", "description": "| Объект с полями свойства, которые нужно изменить (подробное описание)." }, "iblockId": { "type": "string", "description": "| Идентификатор торгового каталога." }, "propertyType": { "type": "string", "description": "| Базовый тип свойства. Допустимые значения описаны в методе catalog.productProperty.add." }, "active": { "type": "string", "maxLength": 1, "description": "| Признак активности. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Код свойства может состоять из латинских символов, цифр и знака подчеркивания. Первый символ не может быть цифрой ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства по умолчанию ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства. Значение должно подходить к `propertyType`, список значений описан в методе catalog.productProperty.add." }, "rowCount": { "type": "integer", "description": "| Число строк поля ввода ||" }, "colCount": { "type": "integer", "description": "| Число колонок поля ввода ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Внешний вид списка. Допустимые значения:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Признак множественного значения. Допустимые значения:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства ||" }, "fileType": { "type": "string", "description": "| Список расширений файлов для свойства типа `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Число полей для ввода множественных значений ||" }, "linkIblockId": { "type": "string", "description": "| Идентификатор связанного инфоблока." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Признак хранения описания значения. Допустимые значения:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Признак участия в поиске. Допустимые значения:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Признак участия в фильтрации. Допустимые значения:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Признак обязательного значения. Допустимые значения:" }, "hint": { "type": "string", "description": "| Подсказка к полю ||" }, "userTypeSettings": { "type": "object", "description": "| Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений." } }, "required": [ "id", "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.add": { "post": { "summary": "Добавить значение списочного свойства catalog.productPropertyEnum.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.add` добавляет значение списочного свойства.", "operationId": "catalog_productPropertyEnum_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового значения списка (подробное описание) ||" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "value": { "type": "string", "description": "| Значение элемента списка ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор значения списка. Должен быть уникальным в рамках свойства, иначе метод вернет ошибку `BX_INVALID_VALUE` ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Признак значения по умолчанию. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "fields", "propertyId", "value", "xmlId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового значения списка (подробное описание) ||" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "value": { "type": "string", "description": "| Значение элемента списка ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор значения списка. Должен быть уникальным в рамках свойства, иначе метод вернет ошибку `BX_INVALID_VALUE` ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Признак значения по умолчанию. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "fields", "propertyId", "value", "xmlId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.delete": { "post": { "summary": "Удалить значение списочного свойства catalog.productPropertyEnum.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.delete` удаляет значение списочного свойства.", "operationId": "catalog_productPropertyEnum_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.get": { "post": { "summary": "Получить значение списочного свойства catalog.productPropertyEnum.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.get` возвращает значение списочного свойства по идентификатору.", "operationId": "catalog_productPropertyEnum_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.getFields": { "post": { "summary": "Получить поля значений списочных свойств catalog.productPropertyEnum.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.getFields` возвращает описание полей значений списочных свойств.", "operationId": "catalog_productPropertyEnum_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.list": { "post": { "summary": "Получить список значений списочных свойств catalog.productPropertyEnum.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.list` возвращает список значений списочных свойств по фильтру.", "operationId": "catalog_productPropertyEnum_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property_enum)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property_enum)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.update": { "post": { "summary": "Изменить значение списочного свойства catalog.productPropertyEnum.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyEnum.update` изменяет значение списочного свойства.", "operationId": "catalog_productPropertyEnum_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-enum/catalog-product-property-enum-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." }, "fields": { "type": "object", "description": "| Объект с полями значения списка (подробное описание)." }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "value": { "type": "string", "description": "| Значение элемента списка ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор значения списка. Должен быть уникальным в рамках свойства ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Признак значения по умолчанию. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } }, "required": [ "id", "fields", "propertyId", "value", "xmlId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списочного свойства." }, "fields": { "type": "object", "description": "| Объект с полями значения списка (подробное описание)." }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "value": { "type": "string", "description": "| Значение элемента списка ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор значения списка. Должен быть уникальным в рамках свойства ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Признак значения по умолчанию. Допустимые значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } }, "required": [ "id", "fields", "propertyId", "value", "xmlId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.add": { "post": { "summary": "Добавить параметр свойства товаров или вариаций catalog.productPropertyFeature.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.add` добавляет параметр свойства товара или вариации.", "operationId": "catalog_productPropertyFeature_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового параметра свойства (подробное описание) ||" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит параметр свойства." }, "featureId": { "type": "string", "description": "| Код параметра свойства." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Признак активности параметра. Допустимые значения:" } }, "required": [ "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей нового параметра свойства (подробное описание) ||" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит параметр свойства." }, "featureId": { "type": "string", "description": "| Код параметра свойства." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Признак активности параметра. Допустимые значения:" } }, "required": [ "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.get": { "post": { "summary": "Получить параметр свойства товаров или вариаций catalog.productPropertyFeature.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.get` возвращает параметр свойства товара или вариации по идентификатору.", "operationId": "catalog_productPropertyFeature_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор параметра свойства." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор параметра свойства." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.getAvailableFeaturesByProperty": { "post": { "summary": "Получить доступные параметры свойств товаров или вариаций catalog.productPropertyFeature.getAvailableFeaturesByProperty", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.getAvailableFeaturesByProperty` возвращает список доступных параметров для указанного свойства товара или вариации.", "operationId": "catalog_productPropertyFeature_getAvailableFeaturesByProperty", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-available-features-by-property.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." } }, "required": [ "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." } }, "required": [ "propertyId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.getFields": { "post": { "summary": "Получить поля параметров свойств товаров или вариаций catalog.productPropertyFeature.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.getFields` возвращает описание полей параметров свойств товаров или вариаций.", "operationId": "catalog_productPropertyFeature_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.list": { "post": { "summary": "Получить список параметров свойств товаров или вариаций catalog.productPropertyFeature.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.list` возвращает список параметров свойств товаров и вариаций по фильтру.", "operationId": "catalog_productPropertyFeature_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property_features)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных параметров в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных параметров в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product_property_features)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных параметров в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных параметров в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.update": { "post": { "summary": "Изменить параметр свойства товаров или вариаций catalog.productPropertyFeature.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertyFeature.update` изменяет параметр свойства товара или вариации.", "operationId": "catalog_productPropertyFeature_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-feature/catalog-product-property-feature-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор параметра свойства." }, "fields": { "type": "object", "description": "| Объект с полями параметра свойства (подробное описание)." }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит параметр свойства." }, "featureId": { "type": "string", "description": "| Код параметра свойства." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Признак активности параметра. Допустимые значения:" } }, "required": [ "id", "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор параметра свойства." }, "fields": { "type": "object", "description": "| Объект с полями параметра свойства (подробное описание)." }, "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, которому принадлежит параметр свойства." }, "featureId": { "type": "string", "description": "| Код параметра свойства." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Признак активности параметра. Допустимые значения:" } }, "required": [ "id", "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.get": { "post": { "summary": "Получить секционные настройки свойства catalog.productPropertySection.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertySection.get` возвращает секционные настройки свойства товара или вариации по идентификатору свойства.", "operationId": "catalog_productPropertySection_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-section/catalog-product-property-section-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." } }, "required": [ "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." } }, "required": [ "propertyId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.list": { "post": { "summary": "Получить список секционных настроек свойств catalog.productPropertySection.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertySection.list` возвращает список секционных настроек свойств товаров и вариаций по фильтру.", "operationId": "catalog_productPropertySection_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-section/catalog-product-property-section-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных настроек в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных настроек в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных настроек в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных настроек в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.set": { "post": { "summary": "Установить секционные настройки свойства catalog.productPropertySection.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.productPropertySection.set` устанавливает секционные настройки свойства товара или вариации.", "operationId": "catalog_productPropertySection_set", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/product-property-section/catalog-product-property-section-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "fields": { "type": "object", "description": "| Поля секционных настроек свойства (подробное описание)." }, "smartFilter": { "type": "string", "maxLength": 1, "description": "| Показывать ли свойство в умном фильтре. Возможные значения:" }, "displayType": { "type": "string", "maxLength": 1, "description": "| Вид свойства в умном фильтре. Набор значений зависит от типа свойства:" }, "displayExpanded": { "type": "string", "maxLength": 1, "description": "| Показывать ли свойство развернутым в фильтре. Возможные значения:" }, "filterHint": { "type": "string", "description": "| Подсказка в умном фильтре для посетителей ||" } }, "required": [ "propertyId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Идентификатор свойства товара или вариации." }, "fields": { "type": "object", "description": "| Поля секционных настроек свойства (подробное описание)." }, "smartFilter": { "type": "string", "maxLength": 1, "description": "| Показывать ли свойство в умном фильтре. Возможные значения:" }, "displayType": { "type": "string", "maxLength": 1, "description": "| Вид свойства в умном фильтре. Набор значений зависит от типа свойства:" }, "displayExpanded": { "type": "string", "maxLength": 1, "description": "| Показывать ли свойство развернутым в фильтре. Возможные значения:" }, "filterHint": { "type": "string", "description": "| Подсказка в умном фильтре для посетителей ||" } }, "required": [ "propertyId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.field.get": { "post": { "summary": "Получить поле коэффициента единицы измерения catalog.ratio.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_ratio_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/ratio/catalog-ratio-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.field.list": { "post": { "summary": "Получить список полей коэффициента единицы измерения v 3.0 catalog.ratio.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_ratio_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/ratio/catalog-ratio-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.get": { "post": { "summary": "Получить значения полей коэффициента единицы измерения v 3.0 catalog.ratio.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_ratio_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/ratio/catalog-ratio-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи коэффициента, а не товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей коэффициента, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи коэффициента, а не товара." }, "select": { "type": "array", "items": {}, "description": "| Массив полей коэффициента, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.getFields": { "post": { "summary": "Получить поля коэффициента единицы измерения catalog.ratio.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.ratio.getFields` возвращает поля коэффициента единицы измерения и их типы. Признаки `isRequired` и `isReadOnly` описывают поля объекта, но изменить коэффициент через REST нельзя: его задают в карточке товара.", "operationId": "catalog_ratio_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/ratio/catalog-ratio-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.list": { "post": { "summary": "Получить список коэффициентов единиц измерения v 3.0 catalog.ratio.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_ratio_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/ratio/catalog-ratio-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей коэффициента, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество коэффициентов на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество коэффициентов, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей коэффициента, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество коэффициентов на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество коэффициентов, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.add": { "post": { "summary": "Создать правило округления цен catalog.roundingRule.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.add` добавляет правило округления цен.", "operationId": "catalog_roundingRule_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания нового правила округления цен (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, для которого действует правило." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления. Возможные значения:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания нового правила округления цен (подробное описание) ||" }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, для которого действует правило." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления. Возможные значения:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.delete": { "post": { "summary": "Удалить правило округления цен catalog.roundingRule.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.delete` удаляет правило округления цен.", "operationId": "catalog_roundingRule_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.get": { "post": { "summary": "Получить значения полей правила округления цен catalog.roundingRule.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.get` возвращает правило округления цен по идентификатору.", "operationId": "catalog_roundingRule_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.getFields": { "post": { "summary": "Получить поля правила округления цен catalog.roundingRule.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.getFields` возвращает описание полей правила округления цен: тип, обязательность и доступность для изменения.", "operationId": "catalog_roundingRule_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.list": { "post": { "summary": "Получить список правил округления цен по фильтру catalog.roundingRule.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.list` возвращает список правил округления цен.", "operationId": "catalog_roundingRule_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_rounding_rule)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных правил округления цен в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных правил округления цен в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_rounding_rule)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных правил округления цен в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных правил округления цен в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.update": { "post": { "summary": "Изменить правило округления цен catalog.roundingRule.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.roundingRule.update` изменяет правило округления цен.", "operationId": "catalog_roundingRule_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" }, "fields": { "type": "object", "description": "| Значения полей правила округления цен (подробное описание)." }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, для которого действует правило." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления. Возможные значения:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "id", "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор правила округления цен ||" }, "fields": { "type": "object", "description": "| Значения полей правила округления цен (подробное описание)." }, "catalogGroupId": { "type": "string", "description": "| Идентификатор типа цены, для которого действует правило." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления. Возможные значения:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "id", "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.add": { "post": { "summary": "Создать правило округления цен v 3.0 catalog.roundingrule.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового правила округления. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены, для которого действует правило. Тип цены должен существовать." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления." }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового правила округления. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены, для которого действует правило. Тип цены должен существовать." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления." }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.delete": { "post": { "summary": "Удалить правило округления цен v 3.0 catalog.roundingrule.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.field.get": { "post": { "summary": "Получить поле правила округления цен catalog.roundingrule.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.field.list": { "post": { "summary": "Получить список полей правила округления цен v 3.0 catalog.roundingrule.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.get": { "post": { "summary": "Получить значения полей правила округления цен v 3.0 catalog.roundingrule.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." }, "select": { "type": "array", "items": {}, "description": "| Массив полей правила, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." }, "select": { "type": "array", "items": {}, "description": "| Массив полей правила, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.list": { "post": { "summary": "Получить список правил округления цен по фильтру v 3.0 catalog.roundingrule.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей правила, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество правил на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество правил, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей правила, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество правил на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество правил, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingrule.update": { "post": { "summary": "Изменить правило округления цен v 3.0 catalog.roundingrule.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_roundingrule_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/rounding-rule/catalog-rounding-rule-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." }, "fields": { "type": "object", "description": "| Объект с полями правила округления, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены, для которого действует правило. Тип цены должен существовать." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления." }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор правила округления." }, "fields": { "type": "object", "description": "| Объект с полями правила округления, которые нужно изменить. Передавайте только изменяемые поля. Описание полей ||" }, "catalogGroupId": { "type": "integer", "description": "| Идентификатор типа цены, для которого действует правило. Тип цены должен существовать." }, "price": { "type": "number", "format": "double", "description": "| Минимальная цена, начиная с которой применяется правило. `0` — правило для всех цен типа." }, "roundType": { "type": "integer", "description": "| Тип округления." }, "roundPrecision": { "type": "number", "format": "double", "description": "| Точность округления, например `10` — округление до десятков." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.add": { "post": { "summary": "Добавить раздел торгового каталога v 3.0 catalog.section.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового раздела. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога, в котором создается раздел. После создания инфоблок раздела изменить нельзя." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела. Раздел должен находиться в том же инфоблоке." }, "active": { "type": "string", "description": "| Активность раздела." }, "code": { "type": "string", "description": "| Символьный код раздела. Если в настройках инфоблока включена уникальность символьного кода разделов, код должен быть уникальным в инфоблоке ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела, например для синхронизации с учетной системой ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "description": { "type": "string", "description": "| Описание раздела ||" }, "descriptionType": { "type": "string", "description": "| Формат описания." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового раздела. Описание полей ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока торгового каталога, в котором создается раздел. После создания инфоблок раздела изменить нельзя." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела. Раздел должен находиться в том же инфоблоке." }, "active": { "type": "string", "description": "| Активность раздела." }, "code": { "type": "string", "description": "| Символьный код раздела. Если в настройках инфоблока включена уникальность символьного кода разделов, код должен быть уникальным в инфоблоке ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела, например для синхронизации с учетной системой ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "description": { "type": "string", "description": "| Описание раздела ||" }, "descriptionType": { "type": "string", "description": "| Формат описания." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.delete": { "post": { "summary": "Удалить раздел торгового каталога v 3.0 catalog.section.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.field.get": { "post": { "summary": "Получить поле раздела торгового каталога catalog.section.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.field.list": { "post": { "summary": "Получить список полей раздела торгового каталога v 3.0 catalog.section.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.get": { "post": { "summary": "Получить значения полей раздела торгового каталога v 3.0 catalog.section.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." }, "select": { "type": "array", "items": {}, "description": "| Массив строк с именами полей раздела, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"iblockSectionId\",\"active\"]`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." }, "select": { "type": "array", "items": {}, "description": "| Массив строк с именами полей раздела, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"iblockSectionId\",\"active\"]`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.getFields": { "post": { "summary": "Получить поля раздела торгового каталога catalog.section.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.section.getFields` возвращает доступные поля раздела каталога.", "operationId": "catalog_section_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.list": { "post": { "summary": "Получить список разделов торгового каталога v 3.0 catalog.section.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по `iblockId` обязательно. Описание полей фильтра." }, "select": { "type": "array", "items": {}, "description": "| Массив строк с именами полей раздела, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"iblockSectionId\"]`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"sort\":\"ASC\"}`. Направление: `ASC` — по возрастанию, `DESC` — по убыванию." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание структуры объекта ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока. Поддерживается только оператор `=` с одним значением." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела. Условие возвращает только прямые вложенные разделы, без разделов следующих уровней." }, "id": { "type": "integer", "description": "| Идентификатор раздела ||" }, "active": { "type": "string", "description": "| Активность раздела: `Y` или `N` ||" }, "code": { "type": "string", "description": "| Символьный код раздела ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "limit": { "type": "integer", "description": "| Количество разделов на странице." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Используйте вместо `offset` ||" }, "offset": { "type": "integer", "description": "| Количество разделов, которые нужно пропустить. Значение должно быть кратно `limit`: например, при `limit` равном `50` допустимы `0`, `50`, `100`." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по `iblockId` обязательно. Описание полей фильтра." }, "select": { "type": "array", "items": {}, "description": "| Массив строк с именами полей раздела, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"iblockSectionId\"]`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"sort\":\"ASC\"}`. Направление: `ASC` — по возрастанию, `DESC` — по убыванию." }, "pagination": { "type": "object", "description": "| Постраничная навигация. Описание структуры объекта ||" }, "iblockId": { "type": "integer", "description": "| Идентификатор инфоблока. Поддерживается только оператор `=` с одним значением." }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела. Условие возвращает только прямые вложенные разделы, без разделов следующих уровней." }, "id": { "type": "integer", "description": "| Идентификатор раздела ||" }, "active": { "type": "string", "description": "| Активность раздела: `Y` или `N` ||" }, "code": { "type": "string", "description": "| Символьный код раздела ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "limit": { "type": "integer", "description": "| Количество разделов на странице." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Используйте вместо `offset` ||" }, "offset": { "type": "integer", "description": "| Количество разделов, которые нужно пропустить. Значение должно быть кратно `limit`: например, при `limit` равном `50` допустимы `0`, `50`, `100`." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.update": { "post": { "summary": "Изменить раздел торгового каталога v 3.0 catalog.section.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_section_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/section/catalog-section-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." }, "fields": { "type": "object", "description": "| Объект с полями раздела, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела в том же инфоблоке. Значение `0` переносит раздел на верхний уровень. Раздел нельзя перенести внутрь себя или в свой вложенный раздел." }, "active": { "type": "string", "description": "| Активность раздела." }, "code": { "type": "string", "description": "| Символьный код раздела. Если в настройках инфоблока включена уникальность символьного кода разделов, код должен быть уникальным в инфоблоке ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "description": { "type": "string", "description": "| Описание раздела ||" }, "descriptionType": { "type": "string", "description": "| Формат описания." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела." }, "fields": { "type": "object", "description": "| Объект с полями раздела, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "iblockSectionId": { "type": "integer", "description": "| Идентификатор родительского раздела в том же инфоблоке. Значение `0` переносит раздел на верхний уровень. Раздел нельзя перенести внутрь себя или в свой вложенный раздел." }, "active": { "type": "string", "description": "| Активность раздела." }, "code": { "type": "string", "description": "| Символьный код раздела. Если в настройках инфоблока включена уникальность символьного кода разделов, код должен быть уникальным в инфоблоке ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "description": { "type": "string", "description": "| Описание раздела ||" }, "descriptionType": { "type": "string", "description": "| Формат описания." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.add": { "post": { "summary": "Добавить склад catalog.store.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.add` создает склад.", "operationId": "catalog_store_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания склада (подробное описание) ||" }, "address": { "type": "string", "description": "| Адрес склада. Пустая строка не принимается ||" }, "title": { "type": "string", "description": "| Название склада." }, "active": { "type": "string", "description": "| Активность склада. Возможные значения:" }, "description": { "type": "string", "description": "| Описание склада ||" }, "gpsN": { "type": "number", "format": "double", "description": "| Широта склада, например `54.71411`. Можно передать числом или строкой с числом ||" }, "gpsS": { "type": "number", "format": "double", "description": "| Долгота склада, например `20.56675`. Можно передать числом или строкой с числом ||" }, "phone": { "type": "string", "description": "| Телефон склада ||" }, "schedule": { "type": "string", "description": "| График работы склада, например `Пн-Пт 9:00-20:00` ||" }, "email": { "type": "string", "description": "| E-mail склада. Формат адреса метод не проверяет ||" }, "issuingCenter": { "type": "string", "description": "| Является ли склад пунктом выдачи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Порядок сортировки склада в списках." }, "code": { "type": "string", "description": "| Символьный код склада. Уникальность кода метод не проверяет ||" }, "xmlId": { "type": "string", "description": "| Внешний код склада. Используйте его для связи склада с записью во внешней системе ||" } }, "required": [ "fields", "address" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания склада (подробное описание) ||" }, "address": { "type": "string", "description": "| Адрес склада. Пустая строка не принимается ||" }, "title": { "type": "string", "description": "| Название склада." }, "active": { "type": "string", "description": "| Активность склада. Возможные значения:" }, "description": { "type": "string", "description": "| Описание склада ||" }, "gpsN": { "type": "number", "format": "double", "description": "| Широта склада, например `54.71411`. Можно передать числом или строкой с числом ||" }, "gpsS": { "type": "number", "format": "double", "description": "| Долгота склада, например `20.56675`. Можно передать числом или строкой с числом ||" }, "phone": { "type": "string", "description": "| Телефон склада ||" }, "schedule": { "type": "string", "description": "| График работы склада, например `Пн-Пт 9:00-20:00` ||" }, "email": { "type": "string", "description": "| E-mail склада. Формат адреса метод не проверяет ||" }, "issuingCenter": { "type": "string", "description": "| Является ли склад пунктом выдачи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Порядок сортировки склада в списках." }, "code": { "type": "string", "description": "| Символьный код склада. Уникальность кода метод не проверяет ||" }, "xmlId": { "type": "string", "description": "| Внешний код склада. Используйте его для связи склада с записью во внешней системе ||" } }, "required": [ "fields", "address" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.delete": { "post": { "summary": "Удалить склад catalog.store.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.delete` удаляет склад.", "operationId": "catalog_store_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.get": { "post": { "summary": "Получить значения полей склада catalog.store.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.get` возвращает значения всех полей склада по его идентификатору.", "operationId": "catalog_store_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.getFields": { "post": { "summary": "Получить доступные поля склада catalog.store.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.getFields` возвращает описание полей склада: тип, обязательность и доступность для изменения.", "operationId": "catalog_store_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.list": { "post": { "summary": "Получить список складов catalog.store.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.list` возвращает список складов с фильтрацией, сортировкой и постраничной навигацией.", "operationId": "catalog_store_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей склада, которые нужно вернуть. Доступные поля: `active`, `address`, `code`, `dateCreate`, `dateModify`, `description`, `email`, `gpsN`, `gpsS`, `id`, `imageId`, `issuingCenter`, `modifiedBy`, `phone`, `schedule`, `sort`, `title`, `userId`, `xmlId`. Описание полей — в объекте catalo..." }, "filter": { "type": "object", "description": "| Объект для фильтрации складов в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки складов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей склада, которые нужно вернуть. Доступные поля: `active`, `address`, `code`, `dateCreate`, `dateModify`, `description`, `email`, `gpsN`, `gpsS`, `id`, `imageId`, `issuingCenter`, `modifiedBy`, `phone`, `schedule`, `sort`, `title`, `userId`, `xmlId`. Описание полей — в объекте catalo..." }, "filter": { "type": "object", "description": "| Объект для фильтрации складов в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки складов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.update": { "post": { "summary": "Изменить склад catalog.store.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.store.update` изменяет склад.", "operationId": "catalog_store_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store/catalog-store-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." }, "fields": { "type": "object", "description": "| Значения полей склада, которые нужно изменить (подробное описание)." }, "address": { "type": "string", "description": "| Адрес склада. Пустая строка не принимается ||" }, "title": { "type": "string", "description": "| Название склада ||" }, "active": { "type": "string", "description": "| Активность склада. Возможные значения:" }, "description": { "type": "string", "description": "| Описание склада ||" }, "gpsN": { "type": "number", "format": "double", "description": "| Широта склада, например `54.71411`." }, "gpsS": { "type": "number", "format": "double", "description": "| Долгота склада, например `20.56675`." }, "phone": { "type": "string", "description": "| Телефон склада ||" }, "schedule": { "type": "string", "description": "| График работы склада, например `Пн-Пт 9:00-20:00` ||" }, "email": { "type": "string", "description": "| E-mail склада. Формат адреса метод не проверяет ||" }, "issuingCenter": { "type": "string", "description": "| Является ли склад пунктом выдачи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Порядок сортировки склада в списках." }, "code": { "type": "string", "description": "| Символьный код склада ||" }, "xmlId": { "type": "string", "description": "| Внешний код склада. Используйте его для связи склада с записью во внешней системе ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор склада." }, "fields": { "type": "object", "description": "| Значения полей склада, которые нужно изменить (подробное описание)." }, "address": { "type": "string", "description": "| Адрес склада. Пустая строка не принимается ||" }, "title": { "type": "string", "description": "| Название склада ||" }, "active": { "type": "string", "description": "| Активность склада. Возможные значения:" }, "description": { "type": "string", "description": "| Описание склада ||" }, "gpsN": { "type": "number", "format": "double", "description": "| Широта склада, например `54.71411`." }, "gpsS": { "type": "number", "format": "double", "description": "| Долгота склада, например `20.56675`." }, "phone": { "type": "string", "description": "| Телефон склада ||" }, "schedule": { "type": "string", "description": "| График работы склада, например `Пн-Пт 9:00-20:00` ||" }, "email": { "type": "string", "description": "| E-mail склада. Формат адреса метод не проверяет ||" }, "issuingCenter": { "type": "string", "description": "| Является ли склад пунктом выдачи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Порядок сортировки склада в списках." }, "code": { "type": "string", "description": "| Символьный код склада ||" }, "xmlId": { "type": "string", "description": "| Внешний код склада. Используйте его для связи склада с записью во внешней системе ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.get": { "post": { "summary": "Получить остатки товара на складе по идентификатору catalog.storeproduct.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.storeproduct.get` возвращает остаток и резерв товара на складе по идентификатору записи остатка.", "operationId": "catalog_storeproduct_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store-product/catalog-store-product-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор записи остатка — не идентификатор товара." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор записи остатка — не идентификатор товара." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.getFields": { "post": { "summary": "Получить поля остатков по складам catalog.storeproduct.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.storeproduct.getFields` возвращает описание полей записи остатка: тип, обязательность и доступность для изменения.", "operationId": "catalog_storeproduct_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store-product/catalog-store-product-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.list": { "post": { "summary": "Получить список остатков по складам по фильтру catalog.storeproduct.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.storeproduct.list` возвращает остатки товаров по складам с фильтрацией, сортировкой и постраничной навигацией.", "operationId": "catalog_storeproduct_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/store-product/catalog-store-product-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей записи остатка, которые нужно вернуть. Доступные поля: `id`, `productId`, `storeId`, `amount`, `quantityReserved`. Описание полей — в объекте catalog_storeproduct." }, "filter": { "type": "object", "description": "| Объект для фильтрации записей остатков в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки записей остатков в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей записи остатка, которые нужно вернуть. Доступные поля: `id`, `productId`, `storeId`, `amount`, `quantityReserved`. Описание полей — в объекте catalog_storeproduct." }, "filter": { "type": "object", "description": "| Объект для фильтрации записей остатков в формате `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки записей остатков в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.userfield.document.list": { "post": { "summary": "Получить список значений пользовательских полей документов складского учета catalog.userfield.document.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.userfield.document.list` возвращает значения пользовательских полей документов складского учета одного типа с фильтрацией, сортировкой и постраничной навигацией.", "operationId": "catalog_userfield_document_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_userfield_document): `documentId`, `documentType` и пользовательские поля в формате `fieldN`, где `N` — идентификатор поля, например `field7097`." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект сортировки в формате `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "select", "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_userfield_document): `documentId`, `documentType` и пользовательские поля в формате `fieldN`, где `N` — идентификатор поля, например `field7097`." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект сортировки в формате `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "select", "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.userfield.document.update": { "post": { "summary": "Изменить значения пользовательских полей документов складского учета catalog.userfield.document.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.userfield.document.update` обновляет значения пользовательских полей документа складского учета.", "operationId": "catalog_userfield_document_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "description": "| Идентификатор документа складского учета. Идентификатор можно получить методом catalog.document.list ||" }, "fields": { "type": "object", "description": "| Поля для обновления (подробное описание) ||" }, "documentType": { "type": "string", "description": "| Тип документа складского учета. Должен совпадать с типом документа `documentId`, иначе метод вернет ошибку." }, "fieldN": { "type": "string", "description": "| Значение пользовательского поля, где `N` — идентификатор пользовательского поля, например `field287`." } }, "required": [ "documentId", "fields", "documentType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "description": "| Идентификатор документа складского учета. Идентификатор можно получить методом catalog.document.list ||" }, "fields": { "type": "object", "description": "| Поля для обновления (подробное описание) ||" }, "documentType": { "type": "string", "description": "| Тип документа складского учета. Должен совпадать с типом документа `documentId`, иначе метод вернет ошибку." }, "fieldN": { "type": "string", "description": "| Значение пользовательского поля, где `N` — идентификатор пользовательского поля, например `field287`." } }, "required": [ "documentId", "fields", "documentType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.add": { "post": { "summary": "Добавить ставку НДС v 3.0 catalog.vat.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_add", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой ставки НДС. Описание полей ||" }, "rate": { "type": "number", "format": "double", "description": "| Величина ставки НДС в процентах, например `13` или `7.5`." }, "active": { "type": "boolean", "description": "| Активность ставки НДС." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации." } }, "required": [ "fields", "rate" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой ставки НДС. Описание полей ||" }, "rate": { "type": "number", "format": "double", "description": "| Величина ставки НДС в процентах, например `13` или `7.5`." }, "active": { "type": "boolean", "description": "| Активность ставки НДС." }, "sort": { "type": "integer", "description": "| Сортировка. Ноль и отрицательное значение заменяются на `100`, `null` вызывает ошибку валидации." } }, "required": [ "fields", "rate" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.delete": { "post": { "summary": "Удалить ставку НДС v 3.0 catalog.vat.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_delete", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.field.get": { "post": { "summary": "Получить поле ставки НДС catalog.vat.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_field_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.field.list": { "post": { "summary": "Получить список полей ставки НДС v 3.0 catalog.vat.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_field_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть для каждого поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.get": { "post": { "summary": "Получить значения полей ставки НДС v 3.0 catalog.vat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_get", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "select": { "type": "array", "items": {}, "description": "| Массив полей ставки, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "select": { "type": "array", "items": {}, "description": "| Массив полей ставки, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.getFields": { "post": { "summary": "Получить поля ставки НДС catalog.vat.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `catalog.vat.getFields` возвращает описание полей ставки НДС: тип, обязательность и доступность для изменения.", "operationId": "catalog_vat_getFields", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.list": { "post": { "summary": "Получить список ставок НДС по фильтру v 3.0 catalog.vat.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_list", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей ставки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество ставок на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество ставок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей ставки, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно по всем полям из `select`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по всем полям из `select`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество ставок на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль и отрицательное значение возвращают первую страницу." }, "offset": { "type": "integer", "description": "| Количество ставок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.update": { "post": { "summary": "Изменить ставку НДС v 3.0 catalog.vat.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "catalog_vat_update", "tags": [ "Торговый каталог" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/catalog/vat/catalog-vat-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "fields": { "type": "object", "description": "| Объект с полями ставки НДС, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "rate": { "type": "number", "format": "double", "description": "| Величина ставки НДС в процентах, например `10` или `7.5`." }, "active": { "type": "boolean", "description": "| Активность ставки НДС." }, "sort": { "type": "integer", "description": "| Сортировка. Если передать ноль или отрицательное значение, метод оставит прежнюю сортировку и не вернет ошибку. `null` вызывает ошибку валидации ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС." }, "fields": { "type": "object", "description": "| Объект с полями ставки НДС, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "rate": { "type": "number", "format": "double", "description": "| Величина ставки НДС в процентах, например `10` или `7.5`." }, "active": { "type": "boolean", "description": "| Активность ставки НДС." }, "sort": { "type": "integer", "description": "| Сортировка. Если передать ноль или отрицательное значение, метод оставит прежнюю сортировку и не вернет ошибку. `null` вызывает ошибку валидации ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/category.add": { "post": { "summary": "Создать воронку CRM v 3.0 crm.<тип>.category.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой воронки в формате `{\"поле\": \"значение\"}`. Обязательное поле — `name`. Описание параметра ||" }, "sort": { "type": "integer", "description": "| Порядок воронки: метод crm.<тип>.category.list возвращает воронки по возрастанию `sort`. Значение по умолчанию зависит от типа объекта — отличия типов ||" }, "isDefault": { "type": "boolean", "description": "| Признак воронки по умолчанию. Метод принимает поле у контакта, компании и смарт-процесса — отличия типов." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой воронки в формате `{\"поле\": \"значение\"}`. Обязательное поле — `name`. Описание параметра ||" }, "sort": { "type": "integer", "description": "| Порядок воронки: метод crm.<тип>.category.list возвращает воронки по возрастанию `sort`. Значение по умолчанию зависит от типа объекта — отличия типов ||" }, "isDefault": { "type": "boolean", "description": "| Признак воронки по умолчанию. Метод принимает поле у контакта, компании и смарт-процесса — отличия типов." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.delete": { "post": { "summary": "Удалить воронку CRM v 3.0 crm.<тип>.category.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки, которую нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки, которую нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.get": { "post": { "summary": "Получить воронку CRM по идентификатору v 3.0 crm.<тип>.category.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки. У воронки по умолчанию сделки, контакта и компании — `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки. У воронки по умолчанию сделки, контакта и компании — `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.list": { "post": { "summary": "Получить список воронок CRM v 3.0 crm.<тип>.category.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество воронок на странице, от `1` до `100`. Значение больше `100` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль возвращает первую страницу." }, "offset": { "type": "integer", "description": "| Количество воронок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество воронок на странице, от `1` до `100`. Значение больше `100` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль возвращает первую страницу." }, "offset": { "type": "integer", "description": "| Количество воронок, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.add": { "post": { "summary": "Добавить стадию в воронку CRM v 3.0 crm.<тип>.category.stage.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой стадии в формате `{\"поле\": \"значение\"}`. Обязательные поля — `categoryId` и `name`. Описание параметра ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки, в которую нужно добавить стадию. У воронки по умолчанию сделки идентификатор `0`." }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`, например `#39A8EF`. Пустая строка — цвет не задан ||" }, "description": { "type": "string", "description": "| Описание стадии ||" }, "semantics": { "type": "string", "description": "| Группа стадии." }, "sort": { "type": "integer", "description": "| Место стадии в воронке: стадии идут по возрастанию `sort`. Если `sort` не передан, стадия в работе встанет последней среди стадий в работе, перед стадией успеха. Для стадии провала `sort` нужно передать ||" } }, "required": [ "fields", "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой стадии в формате `{\"поле\": \"значение\"}`. Обязательные поля — `categoryId` и `name`. Описание параметра ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки, в которую нужно добавить стадию. У воронки по умолчанию сделки идентификатор `0`." }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`, например `#39A8EF`. Пустая строка — цвет не задан ||" }, "description": { "type": "string", "description": "| Описание стадии ||" }, "semantics": { "type": "string", "description": "| Группа стадии." }, "sort": { "type": "integer", "description": "| Место стадии в воронке: стадии идут по возрастанию `sort`. Если `sort` не передан, стадия в работе встанет последней среди стадий в работе, перед стадией успеха. Для стадии провала `sort` нужно передать ||" } }, "required": [ "fields", "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.delete": { "post": { "summary": "Удалить стадию воронки CRM v 3.0 crm.<тип>.category.stage.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.get": { "post": { "summary": "Получить стадию воронки CRM по идентификатору v 3.0 crm.<тип>.category.stage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.list": { "post": { "summary": "Получить стадии воронки CRM v 3.0 crm.<тип>.category.stage.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Воронка, стадии которой нужно получить. Описание параметра ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество стадий на странице, от `1` до `100`. Значение больше `100` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль возвращает первую страницу." }, "offset": { "type": "integer", "description": "| Количество стадий, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Воронка, стадии которой нужно получить. Описание параметра ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество стадий на странице, от `1` до `100`. Значение больше `100` вызывает ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`. Ноль возвращает первую страницу." }, "offset": { "type": "integer", "description": "| Количество стадий, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.replace": { "post": { "summary": "Заменить стадии воронки CRM v 3.0 crm.<тип>.category.stage.replace", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_replace", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-replace-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. У воронки по умолчанию сделки идентификатор `0`." }, "stages": { "type": "string", "description": "| Стадии в работе в нужном порядке, до 50 стадий. Обязательное поле каждой стадии — `name`. Описание параметра ||" }, "stageId": { "type": "string", "description": "| Идентификатор существующей стадии воронки, например `DT1038_127:PREPARATION`. Если не передан, метод создаст новую стадию." }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`. Если не передан, у существующей стадии цвет не меняется. Пустая строка убирает цвет ||" } }, "required": [ "categoryId", "stages" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. У воронки по умолчанию сделки идентификатор `0`." }, "stages": { "type": "string", "description": "| Стадии в работе в нужном порядке, до 50 стадий. Обязательное поле каждой стадии — `name`. Описание параметра ||" }, "stageId": { "type": "string", "description": "| Идентификатор существующей стадии воронки, например `DT1038_127:PREPARATION`. Если не передан, метод создаст новую стадию." }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`. Если не передан, у существующей стадии цвет не меняется. Пустая строка убирает цвет ||" } }, "required": [ "categoryId", "stages" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.stage.update": { "post": { "summary": "Изменить стадию воронки CRM v 3.0 crm.<тип>.category.stage.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_stage_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-stage-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Описание параметра ||" }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`. Пустая строка убирает цвет ||" }, "description": { "type": "string", "description": "| Описание стадии ||" }, "semantics": { "type": "string", "description": "| Группа стадии." }, "sort": { "type": "integer", "description": "| Место стадии в воронке: стадии идут по возрастанию `sort` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор стадии, например `DT1038_127:UC_WUHOJE`. Формат идентификатора." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Описание параметра ||" }, "color": { "type": "string", "description": "| Цвет стадии в формате `#RRGGBB`. Пустая строка убирает цвет ||" }, "description": { "type": "string", "description": "| Описание стадии ||" }, "semantics": { "type": "string", "description": "| Группа стадии." }, "sort": { "type": "integer", "description": "| Место стадии в воронке: стадии идут по возрастанию `sort` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/category.update": { "post": { "summary": "Изменить воронку CRM v 3.0 crm.<тип>.category.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "category_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/categories/crm-entity-category-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки, которую нужно изменить. У воронки по умолчанию сделки, контакта и компании — `0`." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Описание параметра ||" }, "sort": { "type": "integer", "description": "| Порядок воронки: метод crm.<тип>.category.list возвращает воронки по возрастанию `sort` ||" }, "isDefault": { "type": "boolean", "description": "| Признак воронки по умолчанию. Метод принимает поле у контакта, компании и смарт-процесса — отличия типов." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор воронки, которую нужно изменить. У воронки по умолчанию сделки, контакта и компании — `0`." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Описание параметра ||" }, "sort": { "type": "integer", "description": "| Порядок воронки: метод crm.<тип>.category.list возвращает воронки по возрастанию `sort` ||" }, "isDefault": { "type": "boolean", "description": "| Признак воронки по умолчанию. Метод принимает поле у контакта, компании и смарт-процесса — отличия типов." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/clientrequisite.get": { "post": { "summary": "Получить реквизит клиента в элементе v 3.0 crm.<тип>.clientrequisite.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "clientrequisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-client-requisite-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "select": { "type": "array", "items": {}, "description": "| Список полей ответа: `requisiteId`, `bankRequisiteId`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "select": { "type": "array", "items": {}, "description": "| Список полей ответа: `requisiteId`, `bankRequisiteId`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/clientrequisite.set": { "post": { "summary": "Выбрать реквизит клиента в элементе v 3.0 crm.<тип>.clientrequisite.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "clientrequisite_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-client-requisite-set-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "fields": { "type": "object", "description": "| Выбранная пара реквизитов:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "fields": { "type": "object", "description": "| Выбранная пара реквизитов:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.add": { "post": { "summary": "Добавить системное дело crm.activity.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.activity.todo.add](../todo/crm-activity-todo-add.md).", "operationId": "crm_activity_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/activity-base/crm-activity-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект значений полей дела (подробное описание). Пример структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор элемента CRM ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта CRM ||" }, "TYPE_ID": { "type": "string", "description": "| Тип дела. Обязателен, если не указан `PROVIDER_ID`. Если указан `PROVIDER_ID`, а `TYPE_ID` не задан, метод использует тип «дело провайдера». Доступные значения описаны в справочнике типов дел." }, "COMMUNICATIONS": { "type": "string", "description": "| Массив коммуникаций. Обязателен для звонка, встречи и письма; для дела провайдера может отсутствовать. Для звонка и встречи допускается не более одной коммуникации ||" }, "COMPLETED": { "type": "string", "maxLength": 1, "description": "| Признак завершения дела: `Y` — завершено, `N` — не завершено ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Дата и время срока исполнения дела. Переданное значение игнорируется: срок рассчитывает провайдер дела, а если он срок не установил, используется `START_TIME` ||" }, "DESCRIPTION": { "type": "string", "description": "| Текстовое описание дела ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Тип описания ||" }, "DIRECTION": { "type": "string", "description": "| Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| Время завершения дела ||" }, "FILES": { "type": "string", "description": "| Добавленные в дело файлы ||" }, "LOCATION": { "type": "string", "description": "| Местоположение ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Единица времени напоминания: `1` — минуты, `2` — часы, `3` — дни, `0` — напоминание не задано ||" }, "NOTIFY_VALUE": { "type": "integer", "description": "| Количество единиц `NOTIFY_TYPE` для напоминания. Обязательно, если `NOTIFY_TYPE` больше `0` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных, используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных, используется только для привязки к внешнему источнику ||" }, "PRIORITY": { "type": "string", "description": "| Приоритет ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Дополнительные данные провайдера ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Идентификатор группы провайдера ||" }, "PROVIDER_ID": { "type": "string", "description": "| Идентификатор провайдера ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Идентификатор типа провайдера, статус из справочника ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Дополнительные параметры провайдера ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за дело. Если не указан, метод пытается использовать ответственного элемента CRM, затем текущего пользователя ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Время начала выполнения дела ||" }, "STATUS": { "type": "string", "description": "| Статус дела ||" }, "SUBJECT": { "type": "string", "description": "| Тема дела. Поле обязательно и не может быть пустым ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Добавленные файлы. Для хранилища Диск поле устарело и сохраняется для совместимости, передавайте файлы в `FILES`. Для хранилища WebDAV передайте объекты с `ELEMENT_ID` ||" } }, "required": [ "fields", "SUBJECT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект значений полей дела (подробное описание). Пример структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор элемента CRM ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта CRM ||" }, "TYPE_ID": { "type": "string", "description": "| Тип дела. Обязателен, если не указан `PROVIDER_ID`. Если указан `PROVIDER_ID`, а `TYPE_ID` не задан, метод использует тип «дело провайдера». Доступные значения описаны в справочнике типов дел." }, "COMMUNICATIONS": { "type": "string", "description": "| Массив коммуникаций. Обязателен для звонка, встречи и письма; для дела провайдера может отсутствовать. Для звонка и встречи допускается не более одной коммуникации ||" }, "COMPLETED": { "type": "string", "maxLength": 1, "description": "| Признак завершения дела: `Y` — завершено, `N` — не завершено ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Дата и время срока исполнения дела. Переданное значение игнорируется: срок рассчитывает провайдер дела, а если он срок не установил, используется `START_TIME` ||" }, "DESCRIPTION": { "type": "string", "description": "| Текстовое описание дела ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Тип описания ||" }, "DIRECTION": { "type": "string", "description": "| Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| Время завершения дела ||" }, "FILES": { "type": "string", "description": "| Добавленные в дело файлы ||" }, "LOCATION": { "type": "string", "description": "| Местоположение ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Единица времени напоминания: `1` — минуты, `2` — часы, `3` — дни, `0` — напоминание не задано ||" }, "NOTIFY_VALUE": { "type": "integer", "description": "| Количество единиц `NOTIFY_TYPE` для напоминания. Обязательно, если `NOTIFY_TYPE` больше `0` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных, используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных, используется только для привязки к внешнему источнику ||" }, "PRIORITY": { "type": "string", "description": "| Приоритет ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Дополнительные данные провайдера ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Идентификатор группы провайдера ||" }, "PROVIDER_ID": { "type": "string", "description": "| Идентификатор провайдера ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Идентификатор типа провайдера, статус из справочника ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Дополнительные параметры провайдера ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за дело. Если не указан, метод пытается использовать ответственного элемента CRM, затем текущего пользователя ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Время начала выполнения дела ||" }, "STATUS": { "type": "string", "description": "| Статус дела ||" }, "SUBJECT": { "type": "string", "description": "| Тема дела. Поле обязательно и не может быть пустым ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Добавленные файлы. Для хранилища Диск поле устарело и сохраняется для совместимости, передавайте файлы в `FILES`. Для хранилища WebDAV передайте объекты с `ELEMENT_ID` ||" } }, "required": [ "fields", "SUBJECT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.add": { "post": { "summary": "Добавить бейдж crm.activity.badge.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.badge.add` регистрирует бейдж — значок, который появится на карточке элемента в канбане.", "operationId": "crm_activity_badge_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Не длиннее 30 символов и уникальный ||" }, "type": { "type": "string", "description": "| Тип бейджа. Определяет цвет значка: `success`, `failure`, `warning`, `primary` или `secondary` ||" } }, "required": [ "code", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Не длиннее 30 символов и уникальный ||" }, "type": { "type": "string", "description": "| Тип бейджа. Определяет цвет значка: `success`, `failure`, `warning`, `primary` или `secondary` ||" } }, "required": [ "code", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.delete": { "post": { "summary": "Удалить бейдж по коду crm.activity.badge.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.badge.delete` удаляет бейдж по коду.", "operationId": "crm_activity_badge_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Список занятых кодов возвращает метод crm.activity.badge.list ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Список занятых кодов возвращает метод crm.activity.badge.list ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.get": { "post": { "summary": "Получить информацию о бейдже по коду crm.activity.badge.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.badge.get` возвращает [поля бейджа](./index.md#badge-fields) по его коду.", "operationId": "crm_activity_badge_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Список занятых кодов возвращает метод crm.activity.badge.list ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код бейджа, например `missedCall`. Список занятых кодов возвращает метод crm.activity.badge.list ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.list": { "post": { "summary": "Получить список бейджей crm.activity.badge.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.badge.list` возвращает список бейджей, зарегистрированных в Битрикс24. Каждый элемент списка содержит [поля бейджа](./index.md#badge-fields).", "operationId": "crm_activity_badge_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.add": { "post": { "summary": "Добавить связь дела с элементом CRM crm.activity.binding.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.activity.binding.bind](../../../rest-v3/activities/crm-activity-binding-bind-rest-v3.md).", "operationId": "crm_activity_binding_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/binding/crm-activity-binding-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`." }, "entityTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому нужно привязать дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому нужно привязать дело, например `1`." } }, "required": [ "activityId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`." }, "entityTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому нужно привязать дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому нужно привязать дело, например `1`." } }, "required": [ "activityId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.bind": { "post": { "summary": "Привязать дело к элементу CRM v 3.0 crm.activity.binding.bind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_binding_bind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-binding-bind-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "parent": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. К этому элементу будет привязано дело." } }, "required": [ "activityId", "parent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "parent": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. К этому элементу будет привязано дело." } }, "required": [ "activityId", "parent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.delete": { "post": { "summary": "Удалить связь дела с элементом CRM crm.activity.binding.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.activity.binding.unbind](../../../rest-v3/activities/crm-activity-binding-unbind-rest-v3.md).", "operationId": "crm_activity_binding_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`." }, "entityTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, от которого нужно отвязать дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, от которого нужно отвязать дело, например `1`." } }, "required": [ "activityId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`." }, "entityTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, от которого нужно отвязать дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, от которого нужно отвязать дело, например `1`." } }, "required": [ "activityId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.list": { "post": { "summary": "Получить привязки дела v 3.0 crm.activity.binding.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_binding_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-binding-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр с одним условием `[\"activityId\",\"=\",<идентификатор дела>]`, например `[[\"activityId\",\"=\",8463]]`. Другие поля, операторы и дополнительные условия не поддерживаются." }, "pagination": { "type": "object", "description": "| Параметр принимается для совместимости со списочными методами и на ответ не влияет: метод всегда возвращает все привязки ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр с одним условием `[\"activityId\",\"=\",<идентификатор дела>]`, например `[[\"activityId\",\"=\",8463]]`. Другие поля, операторы и дополнительные условия не поддерживаются." }, "pagination": { "type": "object", "description": "| Параметр принимается для совместимости со списочными методами и на ответ не влияет: метод всегда возвращает все привязки ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.move": { "post": { "summary": "Перенести привязку дела v 3.0 crm.activity.binding.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_binding_move", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-binding-move-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "from": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. Элемент, от которого отвязывается дело. Дело должно быть к нему привязано." }, "to": { "type": "object", "description": "| Элемент CRM, к которому привязывается дело, в том же формате ||" } }, "required": [ "activityId", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "from": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. Элемент, от которого отвязывается дело. Дело должно быть к нему привязано." }, "to": { "type": "object", "description": "| Элемент CRM, к которому привязывается дело, в том же формате ||" } }, "required": [ "activityId", "from", "to" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.unbind": { "post": { "summary": "Отвязать дело от элемента CRM v 3.0 crm.activity.binding.unbind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_binding_unbind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-binding-unbind-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "parent": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. От этого элемента будет отвязано дело." } }, "required": [ "activityId", "parent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела." }, "parent": { "type": "object", "description": "| Элемент CRM в формате `{\"entityTypeId\": 2, \"entityId\": 9001}`: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. От этого элемента будет отвязано дело." } }, "required": [ "activityId", "parent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.call.getTranscript": { "post": { "summary": "Получить расшифровку звонка crm.activity.call.getTranscript", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.call.getTranscript` возвращает текст готовой расшифровки звонка по идентификатору дела CRM.", "operationId": "crm_activity_call_getTranscript", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/activity-base/crm-activity-call-get-transcript.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела типа Звонок, например `12345`." } }, "required": [ "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор дела типа Звонок, например `12345`." } }, "required": [ "activityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.communication.fields": { "post": { "summary": "Получить описание коммуникации crm.activity.communication.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 `crm.activity.field.list` из группы [Дела](../../../rest-v3/activities/index.md): средства связи описывает поле `communications`.", "operationId": "crm_activity_communication_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.complete": { "post": { "summary": "Завершить дело v 3.0 crm.activity.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_complete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-complete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.add": { "post": { "summary": "Добавить конфигурируемое дело crm.activity.configurable.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.configurable.add` добавляет конфигурируемое дело в таймлайн элемента CRM.", "operationId": "crm_activity_configurable_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, в элементе которого создается дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, в котором создается дело, например `1` ||" }, "fields": { "type": "array", "items": {}, "description": "| Ассоциативный массив значений полей дела в виде структуры:" }, "layout": { "type": "string", "description": "| Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры ||" }, "typeId": { "type": "string", "description": "| Тип конфигурируемого дела. Значение, отличное от `CONFIGURABLE`, должно соответствовать типу, который создало то же приложение методом crm.activity.type.add с полем `IS_CONFIGURABLE_TYPE` равным `Y` ||" }, "completed": { "type": "boolean", "description": "| Закрыто ли дело. Значение можно передать как `Y/N`, `1/0` или `true/false` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок исполнения дела в формате ISO 8601, например `2025-02-01T12:00:00+03:00`. Входящему делу крайний срок задать нельзя — метод вернет ошибку `INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| Смещения в минутах относительно крайнего срока. Задают, когда Битрикс24 сформирует по делу записи-пинги. Повторяющиеся значения Битрикс24 отбрасывает ||" }, "isIncomingChannel": { "type": "boolean", "description": "| Создано ли дело из входящего канала. Значение можно передать как `Y/N`, `1/0` или `true/false` ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного за дело ||" }, "badgeCode": { "type": "string", "description": "| Код бейджа — значка на карточке элемента в канбане. Бейдж должен быть заранее зарегистрирован методом crm.activity.badge.add, иначе метод вернет ошибку `WRONG_FIELD_VALUE` ||" }, "originatorId": { "type": "string", "description": "| Идентификатор источника данных ||" }, "originId": { "type": "string", "description": "| Идентификатор элемента в источнике данных ||" } }, "required": [ "ownerTypeId", "ownerId", "fields", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, в элементе которого создается дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, в котором создается дело, например `1` ||" }, "fields": { "type": "array", "items": {}, "description": "| Ассоциативный массив значений полей дела в виде структуры:" }, "layout": { "type": "string", "description": "| Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры ||" }, "typeId": { "type": "string", "description": "| Тип конфигурируемого дела. Значение, отличное от `CONFIGURABLE`, должно соответствовать типу, который создало то же приложение методом crm.activity.type.add с полем `IS_CONFIGURABLE_TYPE` равным `Y` ||" }, "completed": { "type": "boolean", "description": "| Закрыто ли дело. Значение можно передать как `Y/N`, `1/0` или `true/false` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок исполнения дела в формате ISO 8601, например `2025-02-01T12:00:00+03:00`. Входящему делу крайний срок задать нельзя — метод вернет ошибку `INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| Смещения в минутах относительно крайнего срока. Задают, когда Битрикс24 сформирует по делу записи-пинги. Повторяющиеся значения Битрикс24 отбрасывает ||" }, "isIncomingChannel": { "type": "boolean", "description": "| Создано ли дело из входящего канала. Значение можно передать как `Y/N`, `1/0` или `true/false` ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного за дело ||" }, "badgeCode": { "type": "string", "description": "| Код бейджа — значка на карточке элемента в канбане. Бейдж должен быть заранее зарегистрирован методом crm.activity.badge.add, иначе метод вернет ошибку `WRONG_FIELD_VALUE` ||" }, "originatorId": { "type": "string", "description": "| Идентификатор источника данных ||" }, "originId": { "type": "string", "description": "| Идентификатор элемента в источнике данных ||" } }, "required": [ "ownerTypeId", "ownerId", "fields", "layout" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.get": { "post": { "summary": "Получить конфигурируемое дело crm.activity.configurable.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.configurable.get` возвращает конфигурируемое дело по идентификатору: его поля и структуру `layout`, которая задает внешний вид записи в таймлайне.", "operationId": "crm_activity_configurable_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела, например `999` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела, например `999` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.update": { "post": { "summary": "Обновить конфигурируемое дело crm.activity.configurable.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.configurable.update` обновляет поля конфигурируемого дела, структуру его записи в таймлайне или и то, и другое сразу.", "operationId": "crm_activity_configurable_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела, например `999`. Его возвращает метод crm.activity.configurable.add ||" }, "fields": { "type": "array", "items": {}, "description": "| Ассоциативный массив значений полей дела в виде структуры:" }, "layout": { "type": "string", "description": "| Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела, например `999`. Его возвращает метод crm.activity.configurable.add ||" }, "fields": { "type": "array", "items": {}, "description": "| Ассоциативный массив значений полей дела в виде структуры:" }, "layout": { "type": "string", "description": "| Структура, которая задает внешний вид записи в таймлайне. Готовый пример объекта — на странице структуры ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.delete": { "post": { "summary": "Удалить дело v 3.0 crm.activity.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.fields": { "post": { "summary": "Получить список полей дела crm.activity.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 `crm.activity.field.list` из группы [Дела](../../../rest-v3/activities/index.md). Часть полей дела метод REST 3.0 не возвращает: настройки `settings`, данные провайдера `providerParams`, `location`, `status`, `priority` и другие. Если они нужны, используйте этот метод.", "operationId": "crm_activity_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/activity-base/crm-activity-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.get": { "post": { "summary": "Получить дело v 3.0 crm.activity.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.delete": { "post": { "summary": "Удалить набор дополнительных контентных блоков из дела crm.activity.layout.blocks.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.layout.blocks.delete` удаляет набор дополнительных контентных блоков из дела.", "operationId": "crm_activity_layout_blocks_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.get": { "post": { "summary": "Получить набор дополнительных контентных блоков дела crm.activity.layout.blocks.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.layout.blocks.get` получает набор дополнительных контентных блоков дела.", "operationId": "crm_activity_layout_blocks_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.set": { "post": { "summary": "Установить набор дополнительных контентных блоков в дело crm.activity.layout.blocks.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.layout.blocks.set` устанавливает набор дополнительных контентных блоков в дело.", "operationId": "crm_activity_layout_blocks_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" }, "layout": { "type": "string", "description": "| Объект, описывающий набор дополнительных контентных блоков (подробное описание) ||" }, "blocks": { "type": "object", "description": "| Ассоциативный массив контентных блоков. Ключ — идентификатор блока, значение — описание блока ||" }, "type": { "type": "string", "description": "| Что выводит | Обязательные поля `properties` ||" } }, "required": [ "entityTypeId", "entityId", "activityId", "layout", "blocks" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязано дело, например идентификатор сделки ||" }, "activityId": { "type": "integer", "description": "| Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list ||" }, "layout": { "type": "string", "description": "| Объект, описывающий набор дополнительных контентных блоков (подробное описание) ||" }, "blocks": { "type": "object", "description": "| Ассоциативный массив контентных блоков. Ключ — идентификатор блока, значение — описание блока ||" }, "type": { "type": "string", "description": "| Что выводит | Обязательные поля `properties` ||" } }, "required": [ "entityTypeId", "entityId", "activityId", "layout", "blocks" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.list": { "post": { "summary": "Получить список дел v 3.0 crm.activity.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0 — массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"isCompleted\",\"=\",false]]`. Чтобы получить дела одного элемента, передайте объект с привязкой. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id`, `createdTime`, `updatedTime`, `startTime`, `endTime`, `deadlineTime`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "binding": { "type": "object", "description": "| Элемент CRM: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. Оба значения — положительные целые числа ||" }, "conditions": { "type": "array", "items": {}, "description": "| Условия в формате массива, объединяются с привязкой по И ||" }, "limit": { "type": "integer", "description": "| Количество дел на странице. Значения больше `200` уменьшаются до `200`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество дел, которые нужно пропустить от начала списка." } }, "required": [ "binding" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0 — массив условий вида `[\"поле\", \"оператор\", \"значение\"]`, например `[[\"isCompleted\",\"=\",false]]`. Чтобы получить дела одного элемента, передайте объект с привязкой. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей дела, которые нужно вернуть, например `[\"id\",\"subject\",\"deadlineTime\"]`. Доступные поля описаны в обзоре методов дел. Для `bindings` и `communications` можно выбрать вложенные поля через точку: `bindings.entityId`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `id`, `createdTime`, `updatedTime`, `startTime`, `endTime`, `deadlineTime`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "binding": { "type": "object", "description": "| Элемент CRM: `entityTypeId` — идентификатор типа объекта, `entityId` — идентификатор элемента. Оба значения — положительные целые числа ||" }, "conditions": { "type": "array", "items": {}, "description": "| Условия в формате массива, объединяются с привязкой по И ||" }, "limit": { "type": "integer", "description": "| Количество дел на странице. Значения больше `200` уменьшаются до `200`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество дел, которые нужно пропустить от начала списка." } }, "required": [ "binding" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.mail.getContent": { "post": { "summary": "Получить текст письма v 3.0 crm.activity.mail.getContent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_mail_getContent", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-mail-get-content-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор письма — дела с `providerId` равным `CRM_EMAIL`." } }, "required": [ "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор письма — дела с `providerId` равным `CRM_EMAIL`." } }, "required": [ "activityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.mail.getThread": { "post": { "summary": "Получить цепочку писем v 3.0 crm.activity.mail.getThread", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_mail_getThread", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-mail-get-thread-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор любого письма цепочки — дела с `providerId` равным `CRM_EMAIL`." } }, "required": [ "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор любого письма цепочки — дела с `providerId` равным `CRM_EMAIL`." } }, "required": [ "activityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.mail.reply": { "post": { "summary": "Ответить на письмо v 3.0 crm.activity.mail.reply", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_mail_reply", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-mail-reply-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор письма, на которое нужно ответить." }, "body": { "type": "string", "description": "| Текст ответа. Пустая строка и строка из пробелов не принимаются ||" }, "cc": { "type": "string", "description": "| Адреса копии ||" }, "bcc": { "type": "string", "description": "| Адреса скрытой копии ||" }, "from": { "type": "string", "description": "| Адрес отправителя, например `sales@example.com` или `Отдел продаж `. Адрес должен быть среди почтовых ящиков и отправителей, доступных пользователю." }, "senderId": { "type": "integer", "description": "| Идентификатор отправителя. Используйте вместе с `from`: адрес отправителя с этим идентификатором должен совпадать с `from` ||" }, "mailboxId": { "type": "integer", "description": "| Идентификатор почтового ящика. Используйте вместе с `from`: адрес ящика должен совпадать с `from` ||" } }, "required": [ "activityId", "body" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Идентификатор письма, на которое нужно ответить." }, "body": { "type": "string", "description": "| Текст ответа. Пустая строка и строка из пробелов не принимаются ||" }, "cc": { "type": "string", "description": "| Адреса копии ||" }, "bcc": { "type": "string", "description": "| Адреса скрытой копии ||" }, "from": { "type": "string", "description": "| Адрес отправителя, например `sales@example.com` или `Отдел продаж `. Адрес должен быть среди почтовых ящиков и отправителей, доступных пользователю." }, "senderId": { "type": "integer", "description": "| Идентификатор отправителя. Используйте вместе с `from`: адрес отправителя с этим идентификатором должен совпадать с `from` ||" }, "mailboxId": { "type": "integer", "description": "| Идентификатор почтового ящика. Используйте вместе с `from`: адрес ящика должен совпадать с `from` ||" } }, "required": [ "activityId", "body" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.add": { "post": { "summary": "Добавить универсальное дело crm.activity.todo.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.add` добавляет универсальное дело в таймлайн элемента CRM.", "operationId": "crm_activity_todo_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайн которого добавляется дело, например `2` для сделки. Если тип не существует, метод вернет ошибку `NOT_FOUND` ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайн которого добавляется дело, например `1`." }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." }, "title": { "type": "string", "description": "| Название дела. По умолчанию — пустая строка ||" }, "description": { "type": "string", "description": "| Описание дела. Поддерживает BB-код, например `[b]важно[/b]`. По умолчанию — пустая строка ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, ответственного за дело, например `1`. Получить идентификатор можно методом user.get." }, "parentActivityId": { "type": "integer", "description": "| Идентификатор предыдущего дела в таймлайне, например `888`. Получить идентификатор можно методом crm.activity.list." }, "pingOffsets": { "type": "array", "items": {}, "description": "| Массив целых чисел — за сколько минут до крайнего срока отправить напоминания. Например, `[0, 15]` создает 2 напоминания: за 15 минут до крайнего срока и в момент его наступления." }, "colorId": { "type": "string", "description": "| Идентификатор цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "ownerTypeId", "ownerId", "deadline" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайн которого добавляется дело, например `2` для сделки. Если тип не существует, метод вернет ошибку `NOT_FOUND` ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайн которого добавляется дело, например `1`." }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." }, "title": { "type": "string", "description": "| Название дела. По умолчанию — пустая строка ||" }, "description": { "type": "string", "description": "| Описание дела. Поддерживает BB-код, например `[b]важно[/b]`. По умолчанию — пустая строка ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, ответственного за дело, например `1`. Получить идентификатор можно методом user.get." }, "parentActivityId": { "type": "integer", "description": "| Идентификатор предыдущего дела в таймлайне, например `888`. Получить идентификатор можно методом crm.activity.list." }, "pingOffsets": { "type": "array", "items": {}, "description": "| Массив целых чисел — за сколько минут до крайнего срока отправить напоминания. Например, `[0, 15]` создает 2 напоминания: за 15 минут до крайнего срока и в момент его наступления." }, "colorId": { "type": "string", "description": "| Идентификатор цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "ownerTypeId", "ownerId", "deadline" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.update": { "post": { "summary": "Обновить универсальное дело crm.activity.todo.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.update` обновляет несколько свойств универсального дела за один вызов.", "operationId": "crm_activity_todo_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." }, "title": { "type": "string", "description": "| Название дела. Если параметр не передан, название станет пустым ||" }, "description": { "type": "string", "description": "| Описание дела. Поддерживает BB-код, например `[b]важно[/b]`. Если параметр не передан, описание станет пустым ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, ответственного за дело, например `1`. Получить идентификатор можно методом user.get." }, "parentActivityId": { "type": "integer", "description": "| Идентификатор другого дела в таймлайне, с которым нужно связать дело, например `888`. Получить идентификатор можно методом crm.activity.list." }, "pingOffsets": { "type": "array", "items": {}, "description": "| Массив целых чисел — за сколько минут до крайнего срока отправить напоминания. Например, `[0, 15]` создает 2 напоминания: за 15 минут до крайнего срока и в момент его наступления." }, "colorId": { "type": "string", "description": "| Идентификатор цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "id", "ownerTypeId", "ownerId", "deadline" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "deadline": { "type": "string", "format": "date-time", "description": "| Крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." }, "title": { "type": "string", "description": "| Название дела. Если параметр не передан, название станет пустым ||" }, "description": { "type": "string", "description": "| Описание дела. Поддерживает BB-код, например `[b]важно[/b]`. Если параметр не передан, описание станет пустым ||" }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, ответственного за дело, например `1`. Получить идентификатор можно методом user.get." }, "parentActivityId": { "type": "integer", "description": "| Идентификатор другого дела в таймлайне, с которым нужно связать дело, например `888`. Получить идентификатор можно методом crm.activity.list." }, "pingOffsets": { "type": "array", "items": {}, "description": "| Массив целых чисел — за сколько минут до крайнего срока отправить напоминания. Например, `[0, 15]` создает 2 напоминания: за 15 минут до крайнего срока и в момент его наступления." }, "colorId": { "type": "string", "description": "| Идентификатор цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "id", "ownerTypeId", "ownerId", "deadline" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateColor": { "post": { "summary": "Обновить цвет универсального дела crm.activity.todo.updateColor", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.updateColor` обновляет цвет универсального дела.", "operationId": "crm_activity_todo_updateColor", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-color.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "colorId": { "type": "string", "description": "| Идентификатор нового цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "id", "ownerTypeId", "ownerId", "colorId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "colorId": { "type": "string", "description": "| Идентификатор нового цвета дела в таймлайне. Передавайте значение строкой, например `\"3\"`: число вызовет ошибку `100`. Возможные значения:" } }, "required": [ "id", "ownerTypeId", "ownerId", "colorId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateDeadline": { "post": { "summary": "Обновить крайний срок универсального дела crm.activity.todo.updateDeadline", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.updateDeadline` меняет крайний срок универсального дела.", "operationId": "crm_activity_todo_updateDeadline", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-deadline.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "value": { "type": "string", "format": "date-time", "description": "| Новый крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "value": { "type": "string", "format": "date-time", "description": "| Новый крайний срок дела в формате ISO 8601, например `2026-11-03T15:00:00+03:00`." } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateDescription": { "post": { "summary": "Обновить описание универсального дела crm.activity.todo.updateDescription", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.updateDescription` меняет описание в универсальном деле.", "operationId": "crm_activity_todo_updateDescription", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-description.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "value": { "type": "string", "description": "| Новое описание дела. Поддерживает BB-код, например `[b]важно[/b]`." } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "value": { "type": "string", "description": "| Новое описание дела. Поддерживает BB-код, например `[b]важно[/b]`." } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateResponsibleUser": { "post": { "summary": "Обновить ответственного за универсальное дело crm.activity.todo.updateResponsibleUser", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.todo.updateResponsibleUser` обновляет ответственного за универсальное дело.", "operationId": "crm_activity_todo_updateResponsibleUser", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-responsible-user.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, который станет ответственным за дело, например `1`. Получить идентификатор можно методом user.get." } }, "required": [ "id", "ownerTypeId", "ownerId", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор обновляемого дела, например `999`." }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, в таймлайне которого находится дело, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в таймлайне которого находится дело, например `1`." }, "responsibleId": { "type": "integer", "description": "| Идентификатор сотрудника, который станет ответственным за дело, например `1`. Получить идентификатор можно методом user.get." } }, "required": [ "id", "ownerTypeId", "ownerId", "responsibleId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.add": { "post": { "summary": "Добавить пользовательский тип дела crm.activity.type.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.type.add` регистрирует пользовательский тип дела с названием и иконкой.", "operationId": "crm_activity_type_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/types/crm-activity-type-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа дела. Ключи полей передавайте в верхнем регистре, например `TYPE_ID`: ключ `type_id` метод не распознает. Описание полей ||" }, "TYPE_ID": { "type": "string", "description": "| Код типа дела, например `1C`. Не длиннее 100 символов, уникален среди типов текущего приложения." }, "ICON_FILE": { "type": "array", "items": {}, "description": "| Иконка типа дела — массив из имени файла и содержимого в Base64, например `[\"icon.png\", \"iVBORw0KGgo...\"]`." }, "IS_CONFIGURABLE_TYPE": { "type": "string", "description": "| Признак типа для конфигурируемых дел:" } }, "required": [ "fields", "TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового типа дела. Ключи полей передавайте в верхнем регистре, например `TYPE_ID`: ключ `type_id` метод не распознает. Описание полей ||" }, "TYPE_ID": { "type": "string", "description": "| Код типа дела, например `1C`. Не длиннее 100 символов, уникален среди типов текущего приложения." }, "ICON_FILE": { "type": "array", "items": {}, "description": "| Иконка типа дела — массив из имени файла и содержимого в Base64, например `[\"icon.png\", \"iVBORw0KGgo...\"]`." }, "IS_CONFIGURABLE_TYPE": { "type": "string", "description": "| Признак типа для конфигурируемых дел:" } }, "required": [ "fields", "TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.delete": { "post": { "summary": "Удалить пользовательский тип дел crm.activity.type.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.type.delete` удаляет пользовательский тип дела, который зарегистрировало текущее приложение.", "operationId": "crm_activity_type_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/types/crm-activity-type-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TYPE_ID": { "type": "string", "description": "| Код типа дела, например `1C`. Получить коды типов приложения можно методом crm.activity.type.list." } }, "required": [ "TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TYPE_ID": { "type": "string", "description": "| Код типа дела, например `1C`. Получить коды типов приложения можно методом crm.activity.type.list." } }, "required": [ "TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.list": { "post": { "summary": "Получить список пользовательских типов дел crm.activity.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.activity.type.list` получает список пользовательских типов дел, которые зарегистрировало текущее приложение.", "operationId": "crm_activity_type_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/types/crm-activity-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.uncomplete": { "post": { "summary": "Вернуть дело в работу v 3.0 crm.activity.uncomplete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_activity_uncomplete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/activities/crm-activity-uncomplete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор дела." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.update": { "post": { "summary": "Обновить системное дело crm.activity.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.activity.todo.update](../todo/crm-activity-todo-update.md).", "operationId": "crm_activity_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/activities/activity-base/crm-activity-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`. Получить идентификатор можно методом crm.activity.list ||" }, "fields": { "type": "object", "description": "| Объект с изменяемыми полями дела (подробное описание). Пример структуры:" }, "params": { "type": "object", "description": "| Необязательные параметры обновления. Поле `REGISTER_HISTORY_EVENT` принимает `Y` — регистрировать событие в истории, `N` — не регистрировать. По умолчанию событие регистрируется ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор текущего элемента CRM. При обновлении переданное значение игнорируется ||" }, "OWNER_TYPE_ID": { "type": "string", "description": "| Идентификатор типа текущего объекта CRM. При обновлении переданное значение игнорируется ||" }, "TYPE_ID": { "type": "string", "description": "| Тип дела изменить нельзя. Переданное значение игнорируется ||" }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Только для чтения. Переданное значение игнорируется ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Массив коммуникаций. Если передан, должен содержать корректную коммуникацию. Пустой массив или список без корректных коммуникаций вызывает ошибку ||" }, "COMPLETED": { "type": "string", "maxLength": 1, "description": "| Признак завершения дела: `Y` — выполнено, `N` — не выполнено ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Напрямую не изменяется: переданное значение игнорируется ||" }, "FILES": { "type": "string", "description": "| Массив файлов. Для каждого файла передайте объект с `FILE_ID` — идентификатором файла на Диске ||" }, "PROVIDER_ID": { "type": "string", "description": "| Провайдера дела изменить нельзя. Переданное значение игнорируется ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Идентификатор ответственного пользователя. Не требуется при каждом обновлении ||" }, "SUBJECT": { "type": "string", "description": "| Тема дела. Не требуется при каждом обновлении ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Только для чтения. Переданное значение игнорируется ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела в таймлайне, например `999`. Получить идентификатор можно методом crm.activity.list ||" }, "fields": { "type": "object", "description": "| Объект с изменяемыми полями дела (подробное описание). Пример структуры:" }, "params": { "type": "object", "description": "| Необязательные параметры обновления. Поле `REGISTER_HISTORY_EVENT` принимает `Y` — регистрировать событие в истории, `N` — не регистрировать. По умолчанию событие регистрируется ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор текущего элемента CRM. При обновлении переданное значение игнорируется ||" }, "OWNER_TYPE_ID": { "type": "string", "description": "| Идентификатор типа текущего объекта CRM. При обновлении переданное значение игнорируется ||" }, "TYPE_ID": { "type": "string", "description": "| Тип дела изменить нельзя. Переданное значение игнорируется ||" }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Только для чтения. Переданное значение игнорируется ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Массив коммуникаций. Если передан, должен содержать корректную коммуникацию. Пустой массив или список без корректных коммуникаций вызывает ошибку ||" }, "COMPLETED": { "type": "string", "maxLength": 1, "description": "| Признак завершения дела: `Y` — выполнено, `N` — не выполнено ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Напрямую не изменяется: переданное значение игнорируется ||" }, "FILES": { "type": "string", "description": "| Массив файлов. Для каждого файла передайте объект с `FILE_ID` — идентификатором файла на Диске ||" }, "PROVIDER_ID": { "type": "string", "description": "| Провайдера дела изменить нельзя. Переданное значение игнорируется ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Идентификатор ответственного пользователя. Не требуется при каждом обновлении ||" }, "SUBJECT": { "type": "string", "description": "| Тема дела. Не требуется при каждом обновлении ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Только для чтения. Переданное значение игнорируется ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.add": { "post": { "summary": "Добавить адрес crm.address.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0: адреса контактов, компаний и лидов — в группе [Адреса](../../rest-v3/addresses/index.md), адреса реквизитов — в группе [Реквизиты](../../rest-v3/requisites/index.md).", "operationId": "crm_address_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления адреса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта (реквизит или лид) ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления адреса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта (реквизит или лид) ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.delete": { "post": { "summary": "Удалить адрес crm.address.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0: адреса контактов, компаний и лидов — в группе [Адреса](../../rest-v3/addresses/index.md), адреса реквизитов — в группе [Реквизиты](../../rest-v3/requisites/index.md).", "operationId": "crm_address_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для удаления адреса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта (реквизит или лид) ||" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для удаления адреса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта (реквизит или лид) ||" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.fields": { "post": { "summary": "Получить описание полей адреса crm.address.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 `crm.address.field.list` из группы [Адреса](../../rest-v3/addresses/index.md).", "operationId": "crm_address_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа основного родительского объекта." }, "ANCHOR_ID": { "type": "integer", "description": "| Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса." }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа основного родительского объекта." }, "ANCHOR_ID": { "type": "integer", "description": "| Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса." }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.list": { "post": { "summary": "Получить список адресов по фильтру crm.address.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.address.list](../../rest-v3/addresses/crm-address-list-rest-v3.md).", "operationId": "crm_address_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля адресов)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных адресов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных адресов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа основного родительского объекта." }, "ANCHOR_ID": { "type": "integer", "description": "| Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля адресов)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных адресов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных адресов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа основного родительского объекта." }, "ANCHOR_ID": { "type": "integer", "description": "| Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.update": { "post": { "summary": "Изменить адрес реквизита crm.address.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0: адреса контактов, компаний и лидов — в группе [Адреса](../../rest-v3/addresses/index.md), адреса реквизитов — в группе [Реквизиты](../../rest-v3/requisites/index.md).", "operationId": "crm_address_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для изменения адреса." }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "|" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для изменения адреса." }, "TYPE_ID": { "type": "integer", "description": "| Идентификатор типа адреса. Элемент перечисления «Тип адреса»." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор родительского объекта ||" }, "ADDRESS_1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "ADDRESS_2": { "type": "string", "description": "| Квартира / офис ||" }, "CITY": { "type": "string", "description": "| Город ||" }, "POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "REGION": { "type": "string", "description": "| Район ||" }, "PROVINCE": { "type": "string", "description": "| Область ||" }, "COUNTRY": { "type": "string", "description": "| Страна ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Код страны." }, "LOC_ADDR_ID": { "type": "integer", "description": "|" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.add": { "post": { "summary": "Создать цифровое рабочее место crm.automatedsolution.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.add` создает цифровое рабочее место.", "operationId": "crm_automatedsolution_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание) для создания цифрового рабочего места в виде структуры:" }, "title": { "type": "string", "description": "| Название цифрового рабочего места. По названию строится ссылка на раздел рабочего места в Битрикс24 ||" }, "typeIds": { "type": "string", "description": "| Массив идентификаторов типов смарт-процессов (`id`), которые нужно привязать к этому рабочему месту. Если не передан, рабочее место создается без смарт-процессов. Несуществующие идентификаторы игнорируются без ошибки." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание) для создания цифрового рабочего места в виде структуры:" }, "title": { "type": "string", "description": "| Название цифрового рабочего места. По названию строится ссылка на раздел рабочего места в Битрикс24 ||" }, "typeIds": { "type": "string", "description": "| Массив идентификаторов типов смарт-процессов (`id`), которые нужно привязать к этому рабочему месту. Если не передан, рабочее место создается без смарт-процессов. Несуществующие идентификаторы игнорируются без ошибки." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.delete": { "post": { "summary": "Удалить цифровое рабочее место crm.automatedsolution.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.delete` удаляет цифровое рабочее место с идентификатором `id`.", "operationId": "crm_automatedsolution_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (`result.automatedSolution.id`) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке `ID` списка цифровых рабочих мест ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (`result.automatedSolution.id`) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке `ID` списка цифровых рабочих мест ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.fields": { "post": { "summary": "Получить поля цифрового рабочего места crm.automatedsolution.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.fields` возвращает описание полей цифрового рабочего места.", "operationId": "crm_automatedsolution_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.get": { "post": { "summary": "Получить данные о цифровом рабочем месте по id crm.automatedsolution.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.get` возвращает цифровое рабочее место по идентификатору `id`.", "operationId": "crm_automatedsolution_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.list": { "post": { "summary": "Получить список цифровых рабочих мест crm.automatedsolution.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.list` возвращает список цифровых рабочих мест.", "operationId": "crm_automatedsolution_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где ключ — поле, а значение — `ASC` или `DESC`. По умолчанию `{\"id\": \"ASC\"}`. Значения `ASC` и `DESC` пишутся в верхнем регистре, имена полей — в нижнем. Доступные для сортировки поля:" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных цифровых рабочих мест в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Доступные для фильтрации поля:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где ключ — поле, а значение — `ASC` или `DESC`. По умолчанию `{\"id\": \"ASC\"}`. Значения `ASC` и `DESC` пишутся в верхнем регистре, имена полей — в нижнем. Доступные для сортировки поля:" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных цифровых рабочих мест в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Доступные для фильтрации поля:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.update": { "post": { "summary": "Изменить цифровое рабочее место crm.automatedsolution.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automatedsolution.update` изменяет цифровое рабочее место с идентификатором `id`. Поля, которые не переданы, сохраняют прежние значения.", "operationId": "crm_automatedsolution_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (`result.automatedSolution.id`) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке `ID` списка цифровых рабочих мест ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание) для изменения цифрового рабочего места в виде структуры:" }, "title": { "type": "string", "description": "| Название цифрового рабочего места." }, "typeIds": { "type": "string", "description": "| Массив идентификаторов типов смарт-процессов (`id`), которые нужно привязать к этому рабочему месту. Несуществующие идентификаторы игнорируются без ошибки." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор цифрового рабочего места. Его можно получить из ответа метода crm.automatedsolution.add (`result.automatedSolution.id`) или crm.automatedsolution.list. В Битрикс24 идентификатор виден в колонке `ID` списка цифровых рабочих мест ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание) для изменения цифрового рабочего места в виде структуры:" }, "title": { "type": "string", "description": "| Название цифрового рабочего места." }, "typeIds": { "type": "string", "description": "| Массив идентификаторов типов смарт-процессов (`id`), которые нужно привязать к этому рабочему месту. Несуществующие идентификаторы игнорируются без ошибки." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger": { "post": { "summary": "Активировать триггер crm.automation.trigger", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Битрикс24 позволяет пользователям создать особый пользовательский триггер \"Отследить входящий вебхук\". Пользователю предлагается готовый URL вида", "operationId": "crm_automation_trigger", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automation/crm-automation-trigger.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "| Целевой объект для автоматизации, указывается в виде `TYPENAME_ID` (например, `LEAD_25`)" }, "code": { "type": "string", "description": "| Уникальный символьный код триггера, настроенного в Автоматизации на конкретный статус/стадию документа. Взять параметр `code` можно из настроек триггера ||" } }, "required": [ "target" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "| Целевой объект для автоматизации, указывается в виде `TYPENAME_ID` (например, `LEAD_25`)" }, "code": { "type": "string", "description": "| Уникальный символьный код триггера, настроенного в Автоматизации на конкретный статус/стадию документа. Взять параметр `code` можно из настроек триггера ||" } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.add": { "post": { "summary": "Добавить триггер crm.automation.trigger.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automation.trigger.add` регистрирует триггер приложения — событие, по которому CRM может перевести сделку или другой объект на нужную стадию или в статус. Например, приложение телефонии регистрирует триггер «Звонок завершен» с кодом `call_done`. Затем администратор привязывает его к стадии в настройках автоматизации CRM, и приложение запускает триггер методом [crm.automation.trigger.execute](./crm-automation-trigger-execute.md). Порядок работы описан в [обзоре триггеров](./index.md).", "operationId": "crm_automation_trigger_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, уникальный в рамках приложения, например `call_done`. Допустимы латинские буквы, цифры и символы `.`, `-`, `_`." } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, уникальный в рамках приложения, например `call_done`. Допустимы латинские буквы, цифры и символы `.`, `-`, `_`." } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.delete": { "post": { "summary": "Удалить триггер crm.automation.trigger.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automation.trigger.delete` удаляет триггер, который текущее приложение зарегистрировало методом [crm.automation.trigger.add](./crm-automation-trigger-add.md). Например, приложение телефонии больше не отслеживает звонки и удаляет триггер `call_done`. Коды триггеров приложения возвращает метод [crm.automation.trigger.list](./crm-automation-trigger-list.md).", "operationId": "crm_automation_trigger_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, который приложение передало при регистрации, например `call_done` ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, который приложение передало при регистрации, например `call_done` ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.execute": { "post": { "summary": "Запустить выполнение триггера crm.automation.trigger.execute", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automation.trigger.execute` сообщает автоматизации CRM, что для объекта сработал триггер приложения. Если этот триггер привязан к стадии или статусу в настройках автоматизации, он может перевести объект на эту стадию или в этот статус. Например, приложение телефонии запускает триггер `call_done` после звонка, и сделка переходит на стадию «В работе».", "operationId": "crm_automation_trigger_execute", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, который приложение передало при регистрации, например `call_done` ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Тип объекта CRM по справочнику crm.enum.ownertype, например `2` — сделка." }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор объекта CRM, например сделки. Его возвращает метод crm.item.list ||" } }, "required": [ "CODE", "OWNER_TYPE_ID", "OWNER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код триггера, который приложение передало при регистрации, например `call_done` ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Тип объекта CRM по справочнику crm.enum.ownertype, например `2` — сделка." }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор объекта CRM, например сделки. Его возвращает метод crm.item.list ||" } }, "required": [ "CODE", "OWNER_TYPE_ID", "OWNER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.list": { "post": { "summary": "Получить список триггеров crm.automation.trigger.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.automation.trigger.list` возвращает триггеры, которые текущее приложение зарегистрировало методом [crm.automation.trigger.add](./crm-automation-trigger-add.md). Коды триггеров из ответа передают в методы [crm.automation.trigger.execute](./crm-automation-trigger-execute.md) и [crm.automation.trigger.delete](./crm-automation-trigger-delete.md). Например, перед удалением триггера приложение находит в списке его код `CODE`.", "operationId": "crm_automation_trigger_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.add": { "post": { "summary": "Создать новый список обзвона crm.calllist.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.add` создает список обзвона и возвращает его идентификатор.", "operationId": "crm_calllist_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта:" }, "ENTITIES": { "type": "string", "description": "| Массив числовых идентификаторов контактов или компаний. Получить их можно методом crm.item.list." }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` CRM-формы для обзвона: во время звонка сотрудник заполняет в ней данные клиента." } }, "required": [ "ENTITY_TYPE", "ENTITIES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта:" }, "ENTITIES": { "type": "string", "description": "| Массив числовых идентификаторов контактов или компаний. Получить их можно методом crm.item.list." }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` CRM-формы для обзвона: во время звонка сотрудник заполняет в ней данные клиента." } }, "required": [ "ENTITY_TYPE", "ENTITIES" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.get": { "post": { "summary": "Получить информацию о списке обзвона crm.calllist.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.get` возвращает параметры обзвона по идентификатору. В ответе — дата создания, автор, CRM-форма и тип участников. Самих участников метод не возвращает.", "operationId": "crm_calllist_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор обзвона. Получить его можно методами crm.calllist.add и crm.calllist.list. Это не идентификатор дела обзвона в таймлайне ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор обзвона. Получить его можно методами crm.calllist.add и crm.calllist.list. Это не идентификатор дела обзвона в таймлайне ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.items.get": { "post": { "summary": "Получить список участников обзвона crm.calllist.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.items.get` возвращает участников обзвона — контакты или компании — и статус звонка каждому из них.", "operationId": "crm_calllist_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Идентификатор обзвона, можно получить методами crm.calllist.add и crm.calllist.list ||" }, "FILTER": { "type": "object", "description": "| Фильтр по статусу звонка участнику: `{ STATUS: \"код_статуса\" }`, например `{ STATUS: \"IN_WORK\" }`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "LIST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Идентификатор обзвона, можно получить методами crm.calllist.add и crm.calllist.list ||" }, "FILTER": { "type": "object", "description": "| Фильтр по статусу звонка участнику: `{ STATUS: \"код_статуса\" }`, например `{ STATUS: \"IN_WORK\" }`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "LIST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.list": { "post": { "summary": "Получить список обзвонов crm.calllist.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.list` возвращает список обзвонов: идентификатор, дату создания, автора, CRM-форму и тип участников.", "operationId": "crm_calllist_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив полей для выборки. По умолчанию возвращаются все поля." }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "ORDER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив полей для выборки. По умолчанию возвращаются все поля." }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "ORDER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.statuslist": { "post": { "summary": "Получить список статусов обзвона crm.calllist.statuslist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.statuslist` возвращает статусы звонка участникам обзвона, например «В работе», «Успешно», «Неверный номер».", "operationId": "crm_calllist_statuslist", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-statuslist.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.update": { "post": { "summary": "Обновить состав списка обзвона crm.calllist.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.calllist.update` заменяет участников списка обзвона и прикрепленную CRM-форму.", "operationId": "crm_calllist_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Идентификатор обзвона. Получить его можно методами crm.calllist.add и crm.calllist.list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта:" }, "ENTITIES": { "type": "string", "description": "| Массив числовых идентификаторов контактов или компаний, которые должны остаться в обзвоне. Получить их можно методом crm.item.list ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` CRM-формы для обзвона: во время звонка сотрудник заполняет в ней данные клиента." } }, "required": [ "LIST_ID", "ENTITY_TYPE", "ENTITIES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Идентификатор обзвона. Получить его можно методами crm.calllist.add и crm.calllist.list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта:" }, "ENTITIES": { "type": "string", "description": "| Массив числовых идентификаторов контактов или компаний, которые должны остаться в обзвоне. Получить их можно методом crm.item.list ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` CRM-формы для обзвона: во время звонка сотрудник заполняет в ней данные клиента." } }, "required": [ "LIST_ID", "ENTITY_TYPE", "ENTITIES" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.fields": { "post": { "summary": "Получить поля каталога товаров crm.catalog.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.catalog.getFields](../../../catalog/catalog/catalog-catalog-get-fields.md).", "operationId": "crm_catalog_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/catalog/crm-catalog-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор. Только для чтения ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "XML_ID": { "type": "string", "description": "| Символьный код. Только для чтения ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор. Только для чтения ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "XML_ID": { "type": "string", "description": "| Символьный код. Только для чтения ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.get": { "post": { "summary": "Получить товарный каталог по идентификатору crm.catalog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.catalog.get](../../../catalog/catalog/catalog-catalog-get.md).", "operationId": "crm_catalog_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/catalog/crm-catalog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарного каталога ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарного каталога ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.list": { "post": { "summary": "Получить список товарных каталогов crm.catalog.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.catalog.list](../../../catalog/catalog/catalog-catalog-list.md).", "operationId": "crm_catalog_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/catalog/crm-catalog-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.add": { "post": { "summary": "Добавить новую воронку crm.category.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.add](../../rest-v3/categories/crm-entity-category-add-rest-v3.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущности CRM для которой будет создана новая воронка ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой воронки в виде структуры:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "isDefault": { "type": "boolean", "description": "| Является ли воронка, воронкой по умолчанию. Может иметь значения:" } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущности CRM для которой будет создана новая воронка ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой воронки в виде структуры:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "isDefault": { "type": "boolean", "description": "| Является ли воронка, воронкой по умолчанию. Может иметь значения:" } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.delete": { "post": { "summary": "Удалить воронку crm.category.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.delete](../../rest-v3/categories/crm-entity-category-delete-rest-v3.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущности CRM у которой будет удалена воронка ||" }, "id": { "type": "integer", "description": "| Идентификатор удаляемой воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущности CRM у которой будет удалена воронка ||" }, "id": { "type": "integer", "description": "| Идентификатор удаляемой воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.fields": { "post": { "summary": "Получить поля воронки crm.category.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.field.list](../../rest-v3/categories/index.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM, для которого нужно получить информацию о полях воронки ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM, для которого нужно получить информацию о полях воронки ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.get": { "post": { "summary": "Получить воронку по Id crm.category.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.get](../../rest-v3/categories/crm-entity-category-get-rest-v3.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объекта CRM у которого мы желаем получить воронку ||" }, "id": { "type": "integer", "description": "| Идентификатор воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объекта CRM у которого мы желаем получить воронку ||" }, "id": { "type": "integer", "description": "| Идентификатор воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.list": { "post": { "summary": "Получить список воронок crm.category.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.list](../../rest-v3/categories/crm-entity-category-list-rest-v3.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущностей CRM, для которого нужно получить список воронок ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущностей CRM, для которого нужно получить список воронок ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.update": { "post": { "summary": "Обновить воронку crm.category.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.category.update](../../rest-v3/categories/crm-entity-category-update-rest-v3.md). Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.", "operationId": "crm_category_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущностей CRM у которого будет обновлена воронка ||" }, "id": { "type": "integer", "description": "| Идентификатор воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления полей воронки в виде структуры:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "isDefault": { "type": "boolean", "description": "| Является ли воронка, воронкой по умолчанию. Может иметь значения:" } }, "required": [ "entityTypeId", "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа сущностей CRM у которого будет обновлена воронка ||" }, "id": { "type": "integer", "description": "| Идентификатор воронки. Можно получить методом `crm.category.list` или при создании воронки методом `crm.category.add` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления полей воронки в виде структуры:" }, "sort": { "type": "integer", "description": "| Индекс сортировки." }, "isDefault": { "type": "boolean", "description": "| Является ли воронка, воронкой по умолчанию. Может иметь значения:" } }, "required": [ "entityTypeId", "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.add": { "post": { "summary": "Создать новую компанию crm.company.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.add](../rest-v3/items/crm-entity-add-rest-v3.md).", "operationId": "crm_company_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров:" }, "TITLE": { "type": "string", "description": "| Название компании ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Тип компании." }, "INDUSTRY": { "type": "string", "description": "| Сфера деятельности." }, "EMPLOYEES": { "type": "string", "description": "| Количество сотрудников." }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "REVENUE": { "type": "number", "format": "double", "description": "| Годовой оборот ||" }, "LOGO": { "type": "string", "description": "| Логотип компании ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли компания для всех. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент." }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система, например Yandex-Direct, Google-Adwords ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "IS_MY_COMPANY": { "type": "string", "maxLength": 1, "description": "| Является ли компания «моей компанией». Возможные значения:" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этой компании ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор компании во внешней системе ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия данных во внешней системе. Используется для защиты данных от случайного перетирания ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создана ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменена ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров:" }, "TITLE": { "type": "string", "description": "| Название компании ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Тип компании." }, "INDUSTRY": { "type": "string", "description": "| Сфера деятельности." }, "EMPLOYEES": { "type": "string", "description": "| Количество сотрудников." }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "REVENUE": { "type": "number", "format": "double", "description": "| Годовой оборот ||" }, "LOGO": { "type": "string", "description": "| Логотип компании ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли компания для всех. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент." }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система, например Yandex-Direct, Google-Adwords ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "IS_MY_COMPANY": { "type": "string", "maxLength": 1, "description": "| Является ли компания «моей компанией». Возможные значения:" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этой компании ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор компании во внешней системе ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия данных во внешней системе. Используется для защиты данных от случайного перетирания ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создана ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменена ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.add": { "post": { "summary": "Добавить контакт к указанной компании crm.company.contact.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.addfieldvalue](../../rest-v3/items/crm-entity-add-field-value-rest-v3.md) с полем `contactsId`. Метод добавляет компанию контакту не основной. Чтобы сделать ее основной, передайте ее первой в массиве `companiesId` метода [crm.contact.update](../../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_company_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о контакте, который нужно привязать к компании." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к компании." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о контакте, который нужно привязать к компании." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к компании." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.delete": { "post": { "summary": "Удалить контакт из указанной компании crm.company.contact.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.deletefieldvalue](../../rest-v3/items/crm-entity-delete-field-value-rest-v3.md). Передайте в метод поле `contactsId` и идентификатор, который нужно удалить из привязок.", "operationId": "crm_company_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно удалить из привязок компании. Должен быть больше `0`." } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно удалить из привязок компании. Должен быть больше `0`." } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.fields": { "post": { "summary": "Получить описание полей для связи компания-контакт crm.company.contact.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.company.contact.fields` возвращает описание полей для связи компания-контакт.", "operationId": "crm_company_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.delete": { "post": { "summary": "Очистить набор контактов, связанных с указанной компанией crm.company.contact.items.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.update](../../rest-v3/items/crm-entity-update-rest-v3.md). Чтобы удалить все привязки, передайте пустой массив `contactsId: []`.", "operationId": "crm_company_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-items-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.get": { "post": { "summary": "Получить набор контактов, связанных с указанной компанией crm.company.contact.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.get](../../rest-v3/items/crm-entity-get-rest-v3.md): контакты компании возвращает поле `contactsId`. Признак основной компании контакта метод не возвращает, его возвращает поле `companyId` метода [crm.contact.get](../../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_company_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.set": { "post": { "summary": "Установить набор контактов, связанных с указанной компанией crm.company.contact.items.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.update](../../rest-v3/items/crm-entity-update-rest-v3.md) с массивом `contactsId`. Явные `SORT` и `IS_PRIMARY` метод не принимает, для них используйте этот метод.", "operationId": "crm_company_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/contacts/crm-company-contact-items-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты, привязанные к компании. Структуру объекта привязки смотрите ниже." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к компании." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты, привязанные к компании. Структуру объекта привязки смотрите ниже." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к компании." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.delete": { "post": { "summary": "Удалить компанию crm.company.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.delete](../rest-v3/items/crm-entity-delete-rest-v3.md).", "operationId": "crm_company_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Установить общую карточку для всех пользователей crm.company.details.configuration.forceCommonScopeForAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.detailpagelayout.setcommonforall](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.md).", "operationId": "crm_company_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.get": { "post": { "summary": "Получить параметры карточки crm.company.details.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.detailpagelayout.get](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.md).", "operationId": "crm_company_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/custom-form/crm-company-details-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.reset": { "post": { "summary": "Сбросить параметры карточки crm.company.details.configuration.reset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md).", "operationId": "crm_company_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/custom-form/crm-company-details-configuration-reset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get. Нужен только при сбросе личных настроек." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get. Нужен только при сбросе личных настроек." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.set": { "post": { "summary": "Установить параметры карточки crm.company.details.configuration.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.detailpagelayout.update](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.md).", "operationId": "crm_company_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/custom-form/crm-company-details-configuration-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get. Нужен только при установке личных настроек." }, "data": { "type": "string", "description": "| Список `section` описывает конфигурацию разделов полей в карточке компании." }, "title": { "type": "string", "description": "| Название раздела." }, "type": { "type": "string", "description": "| Тип раздела." }, "elements": { "type": "string", "description": "| Массив `section_element` описывает конфигурацию полей в разделе." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" } }, "required": [ "data", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, получить можно методом user.get. Нужен только при установке личных настроек." }, "data": { "type": "string", "description": "| Список `section` описывает конфигурацию разделов полей в карточке компании." }, "title": { "type": "string", "description": "| Название раздела." }, "type": { "type": "string", "description": "| Тип раздела." }, "elements": { "type": "string", "description": "| Массив `section_element` описывает конфигурацию полей в разделе." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" } }, "required": [ "data", "title", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.fields": { "post": { "summary": "Получить описание полей компании crm.company.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Варианты значений полей-списков возвращает метод [crm.company.field.custom.enum.list](../rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.md).", "operationId": "crm_company_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.get": { "post": { "summary": "Получить информацию о компании crm.company.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.get](../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_company_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.list": { "post": { "summary": "Получить список компаний по фильтру crm.company.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.list](../rest-v3/items/crm-entity-list-rest-v3.md).", "operationId": "crm_company_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которыми можно ограничить выборку." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которыми можно ограничить выборку." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.update": { "post": { "summary": "Обновить существующую компанию crm.company.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.update](../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_company_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/crm-company-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров:" }, "TITLE": { "type": "string", "description": "| Название компании ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Тип компании. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=COMPANY_TYPE` ||" }, "LOGO": { "type": "string", "description": "| Логотип ||" }, "INDUSTRY": { "type": "string", "description": "| Сфера деятельности. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=INDUSTRY` ||" }, "EMPLOYEES": { "type": "string", "description": "| Количество сотрудников. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=EMPLOYEES` ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта ||" }, "REVENUE": { "type": "number", "format": "double", "description": "| Годовой оборот ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли компания для всех. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Множественное ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Оригинальная версия. Используется для защиты данных от случайного перетирания внешней системой ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система. Yandex-Direct, Google-Adwords и другие ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "PHONE": { "type": "string", "description": "| Телефон. Множественное ||" }, "EMAIL": { "type": "string", "description": "| E-mail. Множественное ||" }, "WEB": { "type": "string", "description": "| Сайт. Множественное ||" }, "IM": { "type": "string", "description": "| Мессенджер. Множественное ||" }, "LINK": { "type": "string", "description": "| LINK. Множественное ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании ||" }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров:" }, "TITLE": { "type": "string", "description": "| Название компании ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Тип компании. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=COMPANY_TYPE` ||" }, "LOGO": { "type": "string", "description": "| Логотип ||" }, "INDUSTRY": { "type": "string", "description": "| Сфера деятельности. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=INDUSTRY` ||" }, "EMPLOYEES": { "type": "string", "description": "| Количество сотрудников. Значения можно получить методом crm.status.list с фильтром по `ENTITY_ID=EMPLOYEES` ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта ||" }, "REVENUE": { "type": "number", "format": "double", "description": "| Годовой оборот ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли компания для всех. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Множественное ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Оригинальная версия. Используется для защиты данных от случайного перетирания внешней системой ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система. Yandex-Direct, Google-Adwords и другие ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "PHONE": { "type": "string", "description": "| Телефон. Множественное ||" }, "EMAIL": { "type": "string", "description": "| E-mail. Множественное ||" }, "WEB": { "type": "string", "description": "| Сайт. Множественное ||" }, "IM": { "type": "string", "description": "| Мессенджер. Множественное ||" }, "LINK": { "type": "string", "description": "| LINK. Множественное ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.add": { "post": { "summary": "Создать пользовательское поле для компаний crm.company.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.custom.add](../../rest-v3/fields/crm-entity-field-custom-add-rest-v3.md). Поля типов «Список» `enumeration` и «Файл» `file` метод REST 3.0 не создает, для них используйте этот метод.", "operationId": "crm_company_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/userfields/crm-company-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах компаний." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах компаний." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.delete": { "post": { "summary": "Удалить пользовательское поле компаний crm.company.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.custom.delete](../../rest-v3/fields/crm-entity-field-custom-delete-rest-v3.md).", "operationId": "crm_company_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/userfields/crm-company-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к компании." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к компании." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.get": { "post": { "summary": "Получить пользовательское поле компаний по идентификатору crm.company.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.custom.get](../../rest-v3/fields/crm-entity-field-custom-get-rest-v3.md).", "operationId": "crm_company_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/userfields/crm-company-userfield-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к компании." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к компании." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.list": { "post": { "summary": "Получить список пользовательских полей компаний crm.company.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.custom.list](../../rest-v3/fields/crm-entity-field-custom-list-rest-v3.md).", "operationId": "crm_company_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/userfields/crm-company-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.update": { "post": { "summary": "Обновить пользовательское поле компаний crm.company.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.company.field.custom.update](../../rest-v3/fields/crm-entity-field-custom-update-rest-v3.md).", "operationId": "crm_company_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/companies/userfields/crm-company-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.add": { "post": { "summary": "Создать новый контакт crm.contact.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.add](../rest-v3/items/crm-entity-add-rest-v3.md).", "operationId": "crm_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров." }, "HONORIFIC": { "type": "string", "description": "| Обращение." }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "PHOTO": { "type": "string", "description": "| Фотография ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "TYPE_ID": { "type": "string", "description": "| Тип контакта." }, "SOURCE_ID": { "type": "string", "description": "| Источник." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "OPENED": { "type": "boolean", "description": "| Доступен ли для всех. Возможные значения:" }, "EXPORT": { "type": "boolean", "description": "| Участвует ли контакт в экспорте. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор основной компании для контакта." }, "COMPANY_IDS": { "type": "string", "description": "| Массив идентификаторов компаний, к которым привязан контакт." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Yandex-Direct, Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "TRACE": { "type": "string", "description": "| Информация для сквозной аналитики ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "LINK": { "type": "string", "description": "| Ссылки. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этом контакте ||" }, "ORIGIN_ID": { "type": "string", "description": "| Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой." }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия оригинала ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания." }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения." }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создан." }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменен." }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая строка адреса ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию события добавления контакта в живой ленте. Возможные значения:" }, "IMPORT": { "type": "boolean", "description": "| Включен ли режим импорта. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров." }, "HONORIFIC": { "type": "string", "description": "| Обращение." }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "PHOTO": { "type": "string", "description": "| Фотография ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "TYPE_ID": { "type": "string", "description": "| Тип контакта." }, "SOURCE_ID": { "type": "string", "description": "| Источник." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "OPENED": { "type": "boolean", "description": "| Доступен ли для всех. Возможные значения:" }, "EXPORT": { "type": "boolean", "description": "| Участвует ли контакт в экспорте. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор основной компании для контакта." }, "COMPANY_IDS": { "type": "string", "description": "| Массив идентификаторов компаний, к которым привязан контакт." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Yandex-Direct, Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "TRACE": { "type": "string", "description": "| Информация для сквозной аналитики ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "LINK": { "type": "string", "description": "| Ссылки. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этом контакте ||" }, "ORIGIN_ID": { "type": "string", "description": "| Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой." }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия оригинала ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания." }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения." }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создан." }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменен." }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая строка адреса ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию события добавления контакта в живой ленте. Возможные значения:" }, "IMPORT": { "type": "boolean", "description": "| Включен ли режим импорта. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.add": { "post": { "summary": "Добавить компанию к указанному контакту crm.contact.company.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.addfieldvalue](../../rest-v3/items/crm-entity-add-field-value-rest-v3.md) с полем `companiesId`. Метод добавляет компанию не основной. Чтобы сделать ее основной, передайте ее первой в массиве `companiesId` метода [crm.contact.update](../../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_contact_company_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о компании, которую нужно привязать к контакту." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно привязать к контакту." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли компанию основной для контакта. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "fields", "COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о компании, которую нужно привязать к контакту." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно привязать к контакту." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли компанию основной для контакта. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "fields", "COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.delete": { "post": { "summary": "Удалить компанию из указанного контакта crm.contact.company.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.deletefieldvalue](../../rest-v3/items/crm-entity-delete-field-value-rest-v3.md). Передайте в метод поле `companiesId` и идентификатор, который нужно удалить из привязок.", "operationId": "crm_contact_company_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какую компанию нужно убрать из привязок." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно убрать из привязок контакта. Должен быть больше `0`." } }, "required": [ "id", "fields", "COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какую компанию нужно убрать из привязок." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно убрать из привязок контакта. Должен быть больше `0`." } }, "required": [ "id", "fields", "COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.fields": { "post": { "summary": "Получить поля для связи контакт-компания crm.contact.company.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.contact.company.fields` возвращает описание полей для связи контакт-компания.", "operationId": "crm_contact_company_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.delete": { "post": { "summary": "Очистить набор компаний, связанных с указанным контактом crm.contact.company.items.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.update](../../rest-v3/items/crm-entity-update-rest-v3.md). Чтобы удалить все привязки, передайте пустой массив `companiesId: []`.", "operationId": "crm_contact_company_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-items-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.get": { "post": { "summary": "Получить набор компаний, связанных с указанным контактом crm.contact.company.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.get](../../rest-v3/items/crm-entity-get-rest-v3.md). Привязки возвращает поле `companiesId`, основную привязку — поле `companyId`.", "operationId": "crm_contact_company_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.set": { "post": { "summary": "Установить набор компаний, связанных с указанным контактом crm.contact.company.items.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.update](../../rest-v3/items/crm-entity-update-rest-v3.md) с массивом `companiesId`: основной станет первая компания массива. Явную сортировку `SORT` метод не принимает, для нее используйте этот метод.", "operationId": "crm_contact_company_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/company/crm-contact-company-items-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают компании контакта. Структуру объекта привязки смотрите ниже." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно привязать к контакту." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли компанию основной для контакта. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают компании контакта. Структуру объекта привязки смотрите ниже." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, которую нужно привязать к контакту." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли компанию основной для контакта. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.delete": { "post": { "summary": "Удалить контакт crm.contact.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.delete](../rest-v3/items/crm-entity-delete-rest-v3.md).", "operationId": "crm_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Установить общую карточку для всех пользователей crm.contact.details.configuration.forceCommonScopeForAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.detailpagelayout.setcommonforall](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.md).", "operationId": "crm_contact_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-force-common-scope-for-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Корневой элемент ответа." }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Корневой элемент ответа." }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.get": { "post": { "summary": "Получить параметры карточки crm.contact.details.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.detailpagelayout.get](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.md).", "operationId": "crm_contact_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при запросе чужих личных настроек." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при запросе чужих личных настроек." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.reset": { "post": { "summary": "Сбросить параметры карточки crm.contact.details.configuration.reset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md).", "operationId": "crm_contact_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-reset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при сбросе личных настроек." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при сбросе личных настроек." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.set": { "post": { "summary": "Установить параметры индивидуальной карточки crm.contact.details.configuration.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.detailpagelayout.update](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.md).", "operationId": "crm_contact_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при установке личных настроек." }, "data": { "type": "string", "description": "| Список `section` описывает конфигурацию разделов полей в карточке элемента." }, "title": { "type": "string", "description": "| Название раздела." }, "type": { "type": "string", "description": "| Тип раздела." }, "elements": { "type": "string", "description": "| Массив `section_element` описывает конфигурацию полей в разделе." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показана ли кнопка принятия оплаты." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показан ли блок «Оплата и доставка»." } }, "required": [ "data", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при установке личных настроек." }, "data": { "type": "string", "description": "| Список `section` описывает конфигурацию разделов полей в карточке элемента." }, "title": { "type": "string", "description": "| Название раздела." }, "type": { "type": "string", "description": "| Тип раздела." }, "elements": { "type": "string", "description": "| Массив `section_element` описывает конфигурацию полей в разделе." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показана ли кнопка принятия оплаты." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показан ли блок «Оплата и доставка»." } }, "required": [ "data", "title", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.fields": { "post": { "summary": "Получить поля контакта crm.contact.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Варианты значений полей-списков возвращает метод [crm.contact.field.custom.enum.list](../rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.md).", "operationId": "crm_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.get": { "post": { "summary": "Получить контакт по Id crm.contact.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.get](../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_contact_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Можно получить при помощи методов `crm.contact.list` или `crm.contact.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта. Можно получить при помощи методов `crm.contact.list` или `crm.contact.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.list": { "post": { "summary": "Получить список контактов crm.contact.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.list](../rest-v3/items/crm-entity-list-rest-v3.md).", "operationId": "crm_contact_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у контактов в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у контактов в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.update": { "post": { "summary": "Изменить контакт crm.contact.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.update](../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_contact_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/crm-contact-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта, который нужно изменить." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров." }, "HONORIFIC": { "type": "string", "description": "| Обращение." }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "PHOTO": { "type": "string", "description": "| Фотография ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "TYPE_ID": { "type": "string", "description": "| Тип контакта." }, "SOURCE_ID": { "type": "string", "description": "| Источник" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "OPENED": { "type": "boolean", "description": "| Доступен ли для всех. Возможные значения:" }, "EXPORT": { "type": "boolean", "description": "| Участвует ли контакт в экспорте. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор основной компании для контакта." }, "COMPANY_IDS": { "type": "string", "description": "| Массив идентификаторов компаний, к которым привязан контакт." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Yandex-Direct, Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "LINK": { "type": "string", "description": "| Ссылки. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этом контакте ||" }, "ORIGIN_ID": { "type": "string", "description": "| Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой." }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия оригинала ||" }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая строка адреса ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию события обновления контакта в живой ленте. Возможные значения:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию обновления контакта в истории. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор контакта, который нужно изменить." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий набор дополнительных параметров." }, "HONORIFIC": { "type": "string", "description": "| Обращение." }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "PHOTO": { "type": "string", "description": "| Фотография ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "TYPE_ID": { "type": "string", "description": "| Тип контакта." }, "SOURCE_ID": { "type": "string", "description": "| Источник" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "OPENED": { "type": "boolean", "description": "| Доступен ли для всех. Возможные значения:" }, "EXPORT": { "type": "boolean", "description": "| Участвует ли контакт в экспорте. Возможные значения:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, ответственного за элемент ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор основной компании для контакта." }, "COMPANY_IDS": { "type": "string", "description": "| Массив идентификаторов компаний, к которым привязан контакт." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Yandex-Direct, Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "PHONE": { "type": "string", "description": "| Телефон ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Сайт ||" }, "IM": { "type": "string", "description": "| Мессенджер ||" }, "LINK": { "type": "string", "description": "| Ссылки. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней системы, являющейся источником данных об этом контакте ||" }, "ORIGIN_ID": { "type": "string", "description": "| Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой." }, "ORIGIN_VERSION": { "type": "string", "description": "| Версия оригинала ||" }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая строка адреса ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Идентификатор адреса местоположения ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию события обновления контакта в живой ленте. Возможные значения:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Производить ли регистрацию обновления контакта в истории. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.add": { "post": { "summary": "Создать пользовательское поле для контактов crm.contact.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.custom.add](../../rest-v3/fields/crm-entity-field-custom-add-rest-v3.md). Поля типов «Список» `enumeration` и «Файл» `file` метод REST 3.0 не создает, для них используйте этот метод.", "operationId": "crm_contact_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/userfield/crm-contact-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах контактов." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля (`USER_TYPE_ID`) существует свой пул доступных настроек, они описаны ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`. Для пользовательских полей другого типа данный параметр не несет смысла." }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах контактов." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля (`USER_TYPE_ID`) существует свой пул доступных настроек, они описаны ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`. Для пользовательских полей другого типа данный параметр не несет смысла." }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.delete": { "post": { "summary": "Удалить пользовательское поле контактов crm.contact.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.custom.delete](../../rest-v3/fields/crm-entity-field-custom-delete-rest-v3.md).", "operationId": "crm_contact_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/userfield/crm-contact-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к контакту." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к контакту." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.get": { "post": { "summary": "Получить пользовательское поле контактов по Id crm.contact.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.custom.get](../../rest-v3/fields/crm-entity-field-custom-get-rest-v3.md).", "operationId": "crm_contact_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/userfield/crm-contact-userfield-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к контакту." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к контакту." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.list": { "post": { "summary": "Получить список пользовательских полей контактов crm.contact.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.custom.list](../../rest-v3/fields/crm-entity-field-custom-list-rest-v3.md).", "operationId": "crm_contact_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/userfield/crm-contact-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным (`Y` — да / `N` — нет) ||" }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным (`Y` — да/ `N` — нет) ||" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке (`Y` — да/ `N` — нет)." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем (`Y` — да/ `N` — нет) ||" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске (`Y` — да/ `N` — нет)" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным (`Y` — да / `N` — нет) ||" }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным (`Y` — да/ `N` — нет) ||" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке (`Y` — да/ `N` — нет)." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем (`Y` — да/ `N` — нет) ||" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске (`Y` — да/ `N` — нет)" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.update": { "post": { "summary": "Изменить существующее пользовательское поле контактов crm.contact.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.contact.field.custom.update](../../rest-v3/fields/crm-entity-field-custom-update-rest-v3.md).", "operationId": "crm_contact_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/contacts/userfield/crm-contact-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля (`USER_TYPE_ID`) существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`. Для пользовательских полей другого типа данный параметр не несет смысла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "ID": { "type": "string", "description": "| Идентификатор элемента списка. При передаче данного параметра будет изменен соответствующий элемент списка, иначе будет добавлен новый элемент списка." }, "DEL": { "type": "boolean", "description": "| Флаг, необходимый для удаления элемента списка. Имеет смысл лишь при передаче `ID`." }, "VALUE": { "type": "string", "description": "| Значение элемента списка ||" }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля (`USER_TYPE_ID`) существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`. Для пользовательских полей другого типа данный параметр не несет смысла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "ID": { "type": "string", "description": "| Идентификатор элемента списка. При передаче данного параметра будет изменен соответствующий элемент списка, иначе будет добавлен новый элемент списка." }, "DEL": { "type": "boolean", "description": "| Флаг, необходимый для удаления элемента списка. Имеет смысл лишь при передаче `ID`." }, "VALUE": { "type": "string", "description": "| Значение элемента списка ||" }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.add": { "post": { "summary": "Добавить валюту crm.currency.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.add` добавляет валюту и возвращает ее код.", "operationId": "crm_currency_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой валюты в виде структуры:" }, "CURRENCY": { "type": "string", "description": "| Идентификатор валюты." }, "BASE": { "type": "string", "description": "| Признак базовой валюты. Метод не учитывает этот параметр и не возвращает ошибку: сделать валюту базовой этим методом нельзя. Базовую валюту меняет метод crm.currency.base.set" }, "AMOUNT_CNT": { "type": "integer", "description": "| Номинал — количество единиц валюты, для которого задан курс `AMOUNT`. Обычно `1`, `10`, `100` и так далее" }, "AMOUNT": { "type": "number", "format": "double", "description": "| Сколько стоит номинал `AMOUNT_CNT` в базовой валюте, например `12.2251` ||" }, "SORT": { "type": "integer", "description": "| Положение в списке валют." }, "LANG": { "type": "object", "description": "| Параметры локализации валюты." }, "DECIMALS": { "type": "integer", "description": "| Количество знаков после запятой ||" }, "DEC_POINT": { "type": "string", "description": "| Десятичный разделитель ||" }, "FORMAT_STRING": { "type": "string", "description": "| Шаблон вывода суммы, например `# CNY` ||" }, "FULL_NAME": { "type": "string", "description": "| Название валюты на языке, для которого добавляется локализация ||" }, "HIDE_ZERO": { "type": "string", "description": "| Скрывать ли незначащие нули: `Y` — скрывать, `N` — показывать. Другие значения метод сохранит как `N` ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Разделитель разрядов ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Код разделителя разрядов." } }, "required": [ "fields", "CURRENCY", "AMOUNT_CNT", "AMOUNT", "FORMAT_STRING" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой валюты в виде структуры:" }, "CURRENCY": { "type": "string", "description": "| Идентификатор валюты." }, "BASE": { "type": "string", "description": "| Признак базовой валюты. Метод не учитывает этот параметр и не возвращает ошибку: сделать валюту базовой этим методом нельзя. Базовую валюту меняет метод crm.currency.base.set" }, "AMOUNT_CNT": { "type": "integer", "description": "| Номинал — количество единиц валюты, для которого задан курс `AMOUNT`. Обычно `1`, `10`, `100` и так далее" }, "AMOUNT": { "type": "number", "format": "double", "description": "| Сколько стоит номинал `AMOUNT_CNT` в базовой валюте, например `12.2251` ||" }, "SORT": { "type": "integer", "description": "| Положение в списке валют." }, "LANG": { "type": "object", "description": "| Параметры локализации валюты." }, "DECIMALS": { "type": "integer", "description": "| Количество знаков после запятой ||" }, "DEC_POINT": { "type": "string", "description": "| Десятичный разделитель ||" }, "FORMAT_STRING": { "type": "string", "description": "| Шаблон вывода суммы, например `# CNY` ||" }, "FULL_NAME": { "type": "string", "description": "| Название валюты на языке, для которого добавляется локализация ||" }, "HIDE_ZERO": { "type": "string", "description": "| Скрывать ли незначащие нули: `Y` — скрывать, `N` — показывать. Другие значения метод сохранит как `N` ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Разделитель разрядов ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Код разделителя разрядов." } }, "required": [ "fields", "CURRENCY", "AMOUNT_CNT", "AMOUNT", "FORMAT_STRING" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.base.get": { "post": { "summary": "Получить символьный идентификатор базовой валюты crm.currency.base.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.base.get` возвращает код базовой валюты, например `RUB`. В базовой валюте компания ведет расчеты. Курсы остальных валют задают относительно нее.", "operationId": "crm_currency_base_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.base.set": { "post": { "summary": "Установить валюту в качестве базовой crm.currency.base.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.base.set` меняет базовую валюту. Если валюты с переданным кодом нет, метод вернет `false` без ошибки — проверьте `result`.", "operationId": "crm_currency_base_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты, которая станет базовой." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты, которая станет базовой." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.delete": { "post": { "summary": "Удалить валюту crm.currency.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.delete` удаляет валюту. Базовую валюту и валюту отчетов метод не удаляет. Чтобы удалить базовую валюту, сначала назначьте базовой другую методом [crm.currency.base.set](./crm-currency-base-set.md).", "operationId": "crm_currency_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.fields": { "post": { "summary": "Получить поля валюты crm.currency.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.fields` возвращает описание полей валюты: тип и название каждого поля, обязательно ли оно и можно ли его менять. Формат описания — [crm_rest_field_description](../data-types.md#crm_rest_field_description).", "operationId": "crm_currency_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.get": { "post": { "summary": "Получить валюту по коду crm.currency.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.get` возвращает валюту по коду, например `USD`. В ответе — курс к базовой валюте, сортировка и параметры вывода на разных языках.", "operationId": "crm_currency_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор валюты." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор валюты." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.list": { "post": { "summary": "Получить список валют crm.currency.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.list` возвращает все валюты Битрикс24 одним ответом. Для каждой валюты — код, курс к базовой валюте, сортировка и параметры вывода. Постраничной выборки у метода нет, параметр `start` не учитывается.", "operationId": "crm_currency_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Необязательный объект для сортировки записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field_N` — идентификатор поля crm_currency, например `sort`. Сортировать можно по полям `sort`, `currency` и `name` — названию валюты." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Необязательный объект для сортировки записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field_N` — идентификатор поля crm_currency, например `sort`. Сортировать можно по полям `sort`, `currency` и `name` — названию валюты." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.delete": { "post": { "summary": "Удалить локализации валюты crm.currency.localizations.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет локализации валюты для указанных языков.", "operationId": "crm_currency_localizations_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/localizations/crm-currency-localizations-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." }, "lids": { "type": "array", "items": {}, "description": "| Массив идентификаторов языков, для которых нужно удалить локализации ||" } }, "required": [ "id", "lids" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." }, "lids": { "type": "array", "items": {}, "description": "| Массив идентификаторов языков, для которых нужно удалить локализации ||" } }, "required": [ "id", "lids" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.fields": { "post": { "summary": "Получить поля локализации валюты crm.currency.localizations.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает доступные поля локализации валюты, то есть настроек, зависящих от языка.", "operationId": "crm_currency_localizations_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/localizations/crm-currency-localizations-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект со списком доступных полей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field_N` — идентификатор поля объекта crm_currency_localization, а `value` — объект типа crm_rest_field_description. ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект со списком доступных полей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field_N` — идентификатор поля объекта crm_currency_localization, а `value` — объект типа crm_rest_field_description. ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.get": { "post": { "summary": "Получить локализации валюты crm.currency.localizations.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает существующие локализации валюты.", "operationId": "crm_currency_localizations_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/localizations/crm-currency-localizations-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.set": { "post": { "summary": "Установить локализации для валюты crm.currency.localizations.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет локализации для валюты или добавляет, если локализация для указанного языка не существует.", "operationId": "crm_currency_localizations_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/localizations/crm-currency-localizations-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." }, "localizations": { "type": "object", "description": "| Параметры локализации валюты." } }, "required": [ "id", "localizations" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор валюты." }, "localizations": { "type": "object", "description": "| Параметры локализации валюты." } }, "required": [ "id", "localizations" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.update": { "post": { "summary": "Обновить валюту crm.currency.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.currency.update` меняет курс, сортировку и локализации валюты.", "operationId": "crm_currency_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор валюты." }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления валюты в виде структуры:" }, "SORT": { "type": "integer", "description": "| Положение в списке валют." }, "AMOUNT_CNT": { "type": "integer", "description": "| Номинал — количество единиц валюты, для которого задан курс `AMOUNT`. Обычно `1`, `10`, `100` и так далее" }, "AMOUNT": { "type": "number", "format": "double", "description": "| Сколько стоит номинал `AMOUNT_CNT` в базовой валюте, например `15.3449` ||" }, "BASE": { "type": "string", "description": "| Признак базовой валюты. Метод не учитывает этот параметр и не возвращает ошибку: сделать валюту базовой этим методом нельзя. Базовую валюту меняет метод crm.currency.base.set" }, "LANG": { "type": "object", "description": "| Параметры локализации валюты." }, "DECIMALS": { "type": "integer", "description": "| Количество знаков после запятой ||" }, "DEC_POINT": { "type": "string", "description": "| Десятичный разделитель ||" }, "FORMAT_STRING": { "type": "string", "description": "| Шаблон вывода суммы, например `$#`. Обязателен, если для языка еще нет локализации ||" }, "FULL_NAME": { "type": "string", "description": "| Название валюты на языке, для которого добавляется локализация ||" }, "HIDE_ZERO": { "type": "string", "description": "| Скрывать ли незначащие нули: `Y` — скрывать, `N` — показывать ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Разделитель разрядов ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Код разделителя разрядов." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор валюты." }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления валюты в виде структуры:" }, "SORT": { "type": "integer", "description": "| Положение в списке валют." }, "AMOUNT_CNT": { "type": "integer", "description": "| Номинал — количество единиц валюты, для которого задан курс `AMOUNT`. Обычно `1`, `10`, `100` и так далее" }, "AMOUNT": { "type": "number", "format": "double", "description": "| Сколько стоит номинал `AMOUNT_CNT` в базовой валюте, например `15.3449` ||" }, "BASE": { "type": "string", "description": "| Признак базовой валюты. Метод не учитывает этот параметр и не возвращает ошибку: сделать валюту базовой этим методом нельзя. Базовую валюту меняет метод crm.currency.base.set" }, "LANG": { "type": "object", "description": "| Параметры локализации валюты." }, "DECIMALS": { "type": "integer", "description": "| Количество знаков после запятой ||" }, "DEC_POINT": { "type": "string", "description": "| Десятичный разделитель ||" }, "FORMAT_STRING": { "type": "string", "description": "| Шаблон вывода суммы, например `$#`. Обязателен, если для языка еще нет локализации ||" }, "FULL_NAME": { "type": "string", "description": "| Название валюты на языке, для которого добавляется локализация ||" }, "HIDE_ZERO": { "type": "string", "description": "| Скрывать ли незначащие нули: `Y` — скрывать, `N` — показывать ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Разделитель разрядов ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Код разделителя разрядов." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.add": { "post": { "summary": "Создать новую сделку crm.deal.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.add](../rest-v3/items/crm-entity-add-rest-v3.md).", "operationId": "crm_deal_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий дополнительный набор параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сделки." }, "TYPE_ID": { "type": "string", "description": "| Строковый идентификатор типа сделки." }, "CATEGORY_ID": { "type": "string", "description": "| Идентификатор воронки. Обязательно больше или равен 0." }, "STAGE_ID": { "type": "string", "description": "| Стадия сделки." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Является ли сделка шаблоном регулярной сделки. Возможные значения:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторной. Возможные значения:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторным обращением. Возможные значения:" }, "PROBABILITY": { "type": "integer", "description": "| Вероятность, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма." }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Включен ли режим ручного подсчета суммы. Возможные значения:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, привязанной к сделке." }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Устаревшее ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к сделке контактов." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата начала." }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Дата завершения." }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли сделка для всех. Возможные значения:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Является ли сделка закрытой. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный." }, "SOURCE_ID": { "type": "string", "description": "| Строковый идентификатор типа источника." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Дополнительная информация ||" }, "LOCATION_ID": { "type": "string", "description": "| Местоположение клиента. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "TRACE": { "type": "string", "description": "| Информация для сквозной аналитики — подробнее читайте в статье {#T} ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Зарегистрировать ли событие добавления сделки в живой ленте. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект, содержащий дополнительный набор параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сделки." }, "TYPE_ID": { "type": "string", "description": "| Строковый идентификатор типа сделки." }, "CATEGORY_ID": { "type": "string", "description": "| Идентификатор воронки. Обязательно больше или равен 0." }, "STAGE_ID": { "type": "string", "description": "| Стадия сделки." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Является ли сделка шаблоном регулярной сделки. Возможные значения:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторной. Возможные значения:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторным обращением. Возможные значения:" }, "PROBABILITY": { "type": "integer", "description": "| Вероятность, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма." }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Включен ли режим ручного подсчета суммы. Возможные значения:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога." }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, привязанной к сделке." }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Устаревшее ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к сделке контактов." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата начала." }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Дата завершения." }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли сделка для всех. Возможные значения:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Является ли сделка закрытой. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный." }, "SOURCE_ID": { "type": "string", "description": "| Строковый идентификатор типа источника." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Дополнительная информация ||" }, "LOCATION_ID": { "type": "string", "description": "| Местоположение клиента. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "TRACE": { "type": "string", "description": "| Информация для сквозной аналитики — подробнее читайте в статье {#T} ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Зарегистрировать ли событие добавления сделки в живой ленте. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.add": { "post": { "summary": "Добавить контакт к сделке crm.deal.contact.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.addfieldvalue](../../rest-v3/items/crm-entity-add-field-value-rest-v3.md) с полем `contactsId`. Основной контакт назначает метод [crm.deal.setprimarycontact](../../rest-v3/items/crm-entity-set-primary-contact-rest-v3.md). Позицию контакта `SORT` метод REST 3.0 не принимает, для нее используйте этот метод.", "operationId": "crm_deal_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "fields": { "type": "object", "description": "| Объект с полями привязки контакта к сделке (подробное описание) ||" }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который будет привязан к сделке" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли контакт основным контактом сделки. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Задает порядок контакта в карточке сделки." } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "fields": { "type": "object", "description": "| Объект с полями привязки контакта к сделке (подробное описание) ||" }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который будет привязан к сделке" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли контакт основным контактом сделки. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Задает порядок контакта в карточке сделки." } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.delete": { "post": { "summary": "Удалить контакт из указанной сделки crm.deal.contact.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.deletefieldvalue](../../rest-v3/items/crm-entity-delete-field-value-rest-v3.md). Передайте в метод поле `contactsId` и идентификатор, который нужно удалить из привязок.", "operationId": "crm_deal_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок (подробное описание) ||" }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который нужно удалить из привязок" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок (подробное описание) ||" }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который нужно удалить из привязок" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.fields": { "post": { "summary": "Получить поля для связи сделка-контакт crm.deal.contact.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.contact.fields` возвращает описание полей для связи сделка-контакт.", "operationId": "crm_deal_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.delete": { "post": { "summary": "Удалить набор контактов, связанных с указанной сделкой crm.deal.contact.items.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.update](../../rest-v3/items/crm-entity-update-rest-v3.md). Чтобы удалить все привязки, передайте пустой массив `contactsId: []`.", "operationId": "crm_deal_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-items-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.get": { "post": { "summary": "Получить набор контактов, связанных с указанной сделкой crm.deal.contact.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.get](../../rest-v3/items/crm-entity-get-rest-v3.md). Привязки возвращает поле `contactsId`, основную привязку — поле `contactId`.", "operationId": "crm_deal_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.set": { "post": { "summary": "Установить набор контактов, связанных с указанной сделкой crm.deal.contact.items.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.update](../../rest-v3/items/crm-entity-update-rest-v3.md) с массивом `contactsId`: основным станет первый контакт массива. Явные `SORT` и `IS_PRIMARY` метод не принимает, для них используйте этот метод.", "operationId": "crm_deal_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/contacts/crm-deal-contact-items-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты, привязанные к сделке (подробное описание)." }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который будет привязан к сделке" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли контакт основным контактом сделки. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "items", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки" }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты, привязанные к сделке (подробное описание)." }, "CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта, который будет привязан к сделке" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли контакт основным контактом сделки. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "items", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.delete": { "post": { "summary": "Удалить сделку crm.deal.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.delete](../rest-v3/items/crm-entity-delete-rest-v3.md).", "operationId": "crm_deal_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Установить общую карточку для всех пользователей crm.deal.details.configuration.forceCommonScopeForAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.detailpagelayout.setcommonforall](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.md). В отличие от `forceCommonScopeForAll`, он не удаляет личные настройки пользователей.", "operationId": "crm_deal_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/custom-form/crm-deal-details-configuration-force-common-scope-for-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.get": { "post": { "summary": "Получить параметры карточки сделки crm.deal.details.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.detailpagelayout.get](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.md).", "operationId": "crm_deal_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/custom-form/crm-deal-details-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при запросе личных настроек другого пользователя." }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при запросе личных настроек другого пользователя." }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.reset": { "post": { "summary": "Сбросить параметры карточки сделки crm.deal.details.configuration.reset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md) с `entityTypeId = 2`. Метода сброса в REST 3.0 нет.", "operationId": "crm_deal_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/custom-form/crm-deal-details-configuration-reset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при сбросе личных настроек другого пользователя." }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при сбросе личных настроек другого пользователя." }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.set": { "post": { "summary": "Установить параметры карточки сделки crm.deal.details.configuration.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.detailpagelayout.update](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.md).", "operationId": "crm_deal_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/custom-form/crm-deal-details-configuration-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при установке личных настроек другого пользователя." }, "data": { "type": "string", "description": "| Список разделов карточки сделки (подробное описание). Разделы и поля, которых нет в `data`, из карточки пропадут ||" }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" }, "title": { "type": "string", "description": "| Название раздела ||" }, "type": { "type": "string", "description": "| Тип раздела" }, "elements": { "type": "string", "description": "| Список выводимых в карточке полей с дополнительными настройками ||" }, "options": { "type": "object", "description": "| Дополнительные опции поля. Состав зависит от поля, например у `CLIENT` — `defaultCountry`, у `OPPORTUNITY_WITH_CURRENCY` — `isPayButtonVisible` и `isPaymentDocumentsVisible`. Если передать не объект, опции не сохранятся, ошибки не будет ||" } }, "required": [ "data", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Область применения настроек." }, "userId": { "type": "string", "description": "| Идентификатор пользователя. Нужен только при установке личных настроек другого пользователя." }, "data": { "type": "string", "description": "| Список разделов карточки сделки (подробное описание). Разделы и поля, которых нет в `data`, из карточки пропадут ||" }, "extras": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "dealCategoryId": { "type": "integer", "description": "| Идентификатор воронки сделок. Можно получить методом crm.category.list с `entityTypeId = 2` или crm.deal.category.list в REST 3.0 — идентификаторы совпадают" }, "title": { "type": "string", "description": "| Название раздела ||" }, "type": { "type": "string", "description": "| Тип раздела" }, "elements": { "type": "string", "description": "| Список выводимых в карточке полей с дополнительными настройками ||" }, "options": { "type": "object", "description": "| Дополнительные опции поля. Состав зависит от поля, например у `CLIENT` — `defaultCountry`, у `OPPORTUNITY_WITH_CURRENCY` — `isPayButtonVisible` и `isPaymentDocumentsVisible`. Если передать не объект, опции не сохранятся, ошибки не будет ||" } }, "required": [ "data", "title", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.fields": { "post": { "summary": "Получить поля сделки crm.deal.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Варианты значений полей-списков возвращает метод [crm.deal.field.custom.enum.list](../rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.md).", "operationId": "crm_deal_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.get": { "post": { "summary": "Получить сделку по Id crm.deal.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.get](../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_deal_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.list": { "post": { "summary": "Получить список сделок crm.deal.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.list](../rest-v3/items/crm-entity-list-rest-v3.md).", "operationId": "crm_deal_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у сделок в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у сделок в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.productrows.get": { "post": { "summary": "Получить товары сделки crm.deal.productrows.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.productrow.list](../rest-v3/product-rows/crm-entity-product-row-list-rest-v3.md).", "operationId": "crm_deal_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-productrows-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Корневой элемент ответа, содержащий массив товарных позиций сделки ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор товарной позиции ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор элемента, к которому привязан товар. Для данного метода всегда будет равен `id` сделки ||" }, "OWNER_TYPE": { "type": "string", "description": "| Строковый идентификатор типа объекта, к которому привязан товар. Для данного метода всегда будет равен `D` ||" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. `0` если не из каталога" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции ||" }, "ORIGINAL_PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции в каталоге ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Описание товарной позиции ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу ||" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "PRICE_ACCOUNT": { "type": "string", "description": "| Стоимость товара в \"валюте отчетов\" ||" }, "QUANTITY": { "type": "integer", "description": "| Количество единиц товара ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "CUSTOMIZED": { "type": "string", "maxLength": 1, "description": "| Изменен (Устаревшее)" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения ||" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "XML_ID": { "type": "string", "description": "| Внешний код товара ||" }, "TYPE": { "type": "integer", "description": "| Тип товара" }, "STORE_ID": { "type": "integer", "description": "| Идентификатор склада. Для получения подробной информации о складе используйте `catalog.store.get` ||" }, "RESERVE_ID": { "type": "integer", "description": "| Идентификатор резерва ||" }, "DATE_RESERVE_END": { "type": "string", "format": "date", "description": "| Дата окончания резервации ||" }, "RESERVE_QUANTITY": { "type": "integer", "description": "| Количество зарезервированных единиц товара ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Корневой элемент ответа, содержащий массив товарных позиций сделки ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор товарной позиции ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор элемента, к которому привязан товар. Для данного метода всегда будет равен `id` сделки ||" }, "OWNER_TYPE": { "type": "string", "description": "| Строковый идентификатор типа объекта, к которому привязан товар. Для данного метода всегда будет равен `D` ||" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. `0` если не из каталога" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции ||" }, "ORIGINAL_PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции в каталоге ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Описание товарной позиции ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу ||" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "PRICE_ACCOUNT": { "type": "string", "description": "| Стоимость товара в \"валюте отчетов\" ||" }, "QUANTITY": { "type": "integer", "description": "| Количество единиц товара ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "CUSTOMIZED": { "type": "string", "maxLength": 1, "description": "| Изменен (Устаревшее)" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения ||" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "XML_ID": { "type": "string", "description": "| Внешний код товара ||" }, "TYPE": { "type": "integer", "description": "| Тип товара" }, "STORE_ID": { "type": "integer", "description": "| Идентификатор склада. Для получения подробной информации о складе используйте `catalog.store.get` ||" }, "RESERVE_ID": { "type": "integer", "description": "| Идентификатор резерва ||" }, "DATE_RESERVE_END": { "type": "string", "format": "date", "description": "| Дата окончания резервации ||" }, "RESERVE_QUANTITY": { "type": "integer", "description": "| Количество зарезервированных единиц товара ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.productrows.set": { "post": { "summary": "Установить товары в сделку crm.deal.productrows.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.productrow.replace](../rest-v3/product-rows/crm-entity-product-row-replace-rest-v3.md).", "operationId": "crm_deal_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-productrows-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Товарные позиции" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. Можно получить список товаров с помощью метода `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции. Если передан `PRODUCT_ID`, то название будет взято у товара" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.)" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "result": { "type": "boolean", "description": "| Корневой элемент ответа, содержит `true` в случае успеха ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Товарные позиции" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. Можно получить список товаров с помощью метода `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции. Если передан `PRODUCT_ID`, то название будет взято у товара" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.)" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "result": { "type": "boolean", "description": "| Корневой элемент ответа, содержит `true` в случае успеха ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.add": { "post": { "summary": "Создать шаблон регулярной сделки crm.deal.recurring.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.add` создает шаблон регулярной сделки на основе сделки.", "operationId": "crm_deal_recurring_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DEAL_ID": { "type": "integer", "description": "| Идентификатор сделки, на основе которой создается шаблон регулярной сделки." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности настройки. Возможные значения:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| id воронки для новых сделок, создаваемых из шаблона." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Ограничение по созданию новых сделок:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное количество сделок, которые можно создать из шаблона. Используется при `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата окончания генерации сделок из шаблона в формате `YYYY-MM-DD`. Используется при `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала расчета следующего запуска в формате `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Параметры периодичности (подробное описание) ||" }, "MODE": { "type": "string", "description": "| Режим повторения:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Тип периода для `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Интервал повторения для `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Тип смещения для `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Значение смещения для `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Тип смещения даты начала создаваемой сделки:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты начала создаваемой сделки ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Тип смещения даты завершения создаваемой сделки:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты завершения создаваемой сделки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DEAL_ID": { "type": "integer", "description": "| Идентификатор сделки, на основе которой создается шаблон регулярной сделки." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности настройки. Возможные значения:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| id воронки для новых сделок, создаваемых из шаблона." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Ограничение по созданию новых сделок:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное количество сделок, которые можно создать из шаблона. Используется при `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата окончания генерации сделок из шаблона в формате `YYYY-MM-DD`. Используется при `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала расчета следующего запуска в формате `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Параметры периодичности (подробное описание) ||" }, "MODE": { "type": "string", "description": "| Режим повторения:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Тип периода для `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Интервал повторения для `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Тип смещения для `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Значение смещения для `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Тип смещения даты начала создаваемой сделки:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты начала создаваемой сделки ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Тип смещения даты завершения создаваемой сделки:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты завершения создаваемой сделки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.delete": { "post": { "summary": "Удалить настройку шаблона регулярной сделки crm.deal.recurring.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.delete` удаляет существующую настройку для шаблона регулярной сделки. Он подходит, когда нужно удалить запись о шаблоне регулярной сделки, если связанная сделка уже отсутствует.", "operationId": "crm_deal_recurring_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.expose": { "post": { "summary": "Создать новую сделку из шаблона crm.deal.recurring.expose", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.expose` создает новую сделку по шаблону регулярной сделки.", "operationId": "crm_deal_recurring_expose", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-expose.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.fields": { "post": { "summary": "Получить список полей шаблона регулярной сделки crm.deal.recurring.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.fields` возвращает описание полей шаблона регулярной сделки.", "operationId": "crm_deal_recurring_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.get": { "post": { "summary": "Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.get` возвращает поля настройки шаблона регулярной сделки по идентификатору.", "operationId": "crm_deal_recurring_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.list": { "post": { "summary": "Получить список настроек шаблонов регулярных сделок crm.deal.recurring.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.list` возвращает список настроек шаблонов регулярных сделок по фильтру.", "operationId": "crm_deal_recurring_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект фильтра формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект фильтра формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.update": { "post": { "summary": "Изменить настройку шаблона регулярной сделки crm.deal.recurring.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.deal.recurring.update` обновляет существующую настройку шаблона регулярной сделки.", "operationId": "crm_deal_recurring_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/recurring-deals/crm-deal-recurring-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности настройки. Возможные значения:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| id воронки для новых сделок, создаваемых из шаблона." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Ограничение по созданию новых сделок:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное количество сделок, которые можно создать из шаблона. Используется при `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата окончания генерации сделок из шаблона в формате `YYYY-MM-DD`. Используется при `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала расчета следующего запуска в формате `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Параметры периодичности (подробное описание) ||" }, "MODE": { "type": "string", "description": "| Режим повторения:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Тип периода для `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Интервал повторения для `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Тип смещения для `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Значение смещения для `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Тип смещения даты начала создаваемой сделки:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты начала создаваемой сделки ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Тип смещения даты завершения создаваемой сделки:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты завершения создаваемой сделки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности настройки. Возможные значения:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| id воронки для новых сделок, создаваемых из шаблона." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Ограничение по созданию новых сделок:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное количество сделок, которые можно создать из шаблона. Используется при `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата окончания генерации сделок из шаблона в формате `YYYY-MM-DD`. Используется при `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала расчета следующего запуска в формате `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Параметры периодичности (подробное описание) ||" }, "MODE": { "type": "string", "description": "| Режим повторения:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Тип периода для `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Интервал повторения для `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Тип смещения для `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Значение смещения для `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Тип смещения даты начала создаваемой сделки:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты начала создаваемой сделки ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Тип смещения даты завершения создаваемой сделки:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Значение смещения даты завершения создаваемой сделки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.update": { "post": { "summary": "Изменить сделку crm.deal.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.update](../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_deal_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/crm-deal-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Набор дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сделки ||" }, "TYPE_ID": { "type": "string", "description": "| Строковый идентификатор типа сделки." }, "STAGE_ID": { "type": "string", "description": "| Стадия сделки." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Является ли сделка шаблоном регулярной сделки. Возможные значения:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторной. Возможные значения:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторным обращением. Возможные значения:" }, "PROBABILITY": { "type": "integer", "description": "| Вероятность, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Включен ли режим ручного подсчета суммы. Возможные значения:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, привязанной к сделке." }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Устаревшее ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к сделке контактов. Поле изменяется полностью." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата начала ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Дата завершения ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли сделка для всех. Возможные значения:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Является ли сделка закрытой. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "SOURCE_ID": { "type": "string", "description": "| Строковый идентификатор типа источника." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Дополнительная информация ||" }, "LOCATION_ID": { "type": "string", "description": "| Местоположение клиента. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Зарегистрировать ли событие изменения сделки в живой ленте. Возможные значения:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Создать ли запись в истории. Возможные значения:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Набор дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сделки ||" }, "TYPE_ID": { "type": "string", "description": "| Строковый идентификатор типа сделки." }, "STAGE_ID": { "type": "string", "description": "| Стадия сделки." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Является ли сделка шаблоном регулярной сделки. Возможные значения:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторной. Возможные значения:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Является ли сделка повторным обращением. Возможные значения:" }, "PROBABILITY": { "type": "integer", "description": "| Вероятность, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Включен ли режим ручного подсчета суммы. Возможные значения:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании, привязанной к сделке." }, "CONTACT_ID": { "type": "string", "description": "| Контакт. Устаревшее ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к сделке контактов. Поле изменяется полностью." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата начала ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Дата завершения ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступна ли сделка для всех. Возможные значения:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Является ли сделка закрытой. Возможные значения:" }, "COMMENTS": { "type": "string", "description": "| Комментарий. Поддерживает bb-коды ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "SOURCE_ID": { "type": "string", "description": "| Строковый идентификатор типа источника." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Дополнительно об источнике ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Дополнительная информация ||" }, "LOCATION_ID": { "type": "string", "description": "| Местоположение клиента. Служебное поле ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных." }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система (Google-Adwords и другие) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. Возможные значения:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Зарегистрировать ли событие изменения сделки в живой ленте. Возможные значения:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Создать ли запись в истории. Возможные значения:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.add": { "post": { "summary": "Создать пользовательское поле для сделок crm.deal.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.custom.add](../../rest-v3/fields/crm-entity-field-custom-add-rest-v3.md). Поля типов «Список» `enumeration` и «Файл» `file` метод REST 3.0 не создает, для них используйте этот метод.", "operationId": "crm_deal_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Список типов, доступных в Битрикс24, возвращает метод crm.userfield.types. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах сделок. Полное имя поля с префиксом — ключ, по которому значение поля записывают методом crm.deal.update и читают методом crm.deal.get." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой набор настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Список типов, доступных в Битрикс24, возвращает метод crm.userfield.types. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах сделок. Полное имя поля с префиксом — ключ, по которому значение поля записывают методом crm.deal.update и читают методом crm.deal.get." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой набор настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.delete": { "post": { "summary": "Удалить пользовательское поле сделок crm.deal.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.custom.delete](../../rest-v3/fields/crm-entity-field-custom-delete-rest-v3.md).", "operationId": "crm_deal_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля сделок." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля сделок." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.get": { "post": { "summary": "Получить пользовательское поле сделок по ID crm.deal.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.custom.get](../../rest-v3/fields/crm-entity-field-custom-get-rest-v3.md).", "operationId": "crm_deal_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля сделок." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля сделок." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.list": { "post": { "summary": "Получить список пользовательских полей сделок crm.deal.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.custom.list](../../rest-v3/fields/crm-entity-field-custom-list-rest-v3.md).", "operationId": "crm_deal_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Имя поля с префиксом `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. Если передать `LANG`, метод вернет подписи поля на этом языке:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Имя поля с префиксом `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. Если передать `LANG`, метод вернет подписи поля на этом языке:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.update": { "post": { "summary": "Изменить существующее пользовательское поле сделок crm.deal.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.deal.field.custom.update](../../rest-v3/fields/crm-entity-field-custom-update-rest-v3.md).", "operationId": "crm_deal_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой набор настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "ID": { "type": "integer", "description": "| Идентификатор существующего элемента списка ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEL": { "type": "string", "maxLength": 1, "description": "| Удалять ли элемент с переданным `ID`. Возможные значения:" }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой набор настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь." }, "ID": { "type": "integer", "description": "| Идентификатор существующего элемента списка ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEL": { "type": "string", "maxLength": 1, "description": "| Удалять ли элемент с переданным `ID`. Возможные значения:" }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.add": { "post": { "summary": "Создать новое направление сделок crm.dealcategory.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.add](../../universal/category/crm-category-add.md).", "operationId": "crm_dealcategory_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания направления сделок." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания направления сделок." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.default.get": { "post": { "summary": "Получить настройки общего направления сделок crm.dealcategory.default.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.*](../../universal/category/index.md).", "operationId": "crm_dealcategory_default_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-default-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.default.set": { "post": { "summary": "Установить настройки общего направления сделок crm.dealcategory.default.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.*](../../universal/category/index.md).", "operationId": "crm_dealcategory_default_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-default-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.delete": { "post": { "summary": "Удалить направление сделок crm.dealcategory.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.delete](../../universal/category/crm-category-delete.md).", "operationId": "crm_dealcategory_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.fields": { "post": { "summary": "Получить описания полей направления сделок crm.dealcategory.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.fields](../../universal/category/crm-category-fields.md).", "operationId": "crm_dealcategory_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "ID": { "type": "integer", "description": "| Идентификатор направления сделки ||" }, "IS_LOCKED": { "type": "string", "maxLength": 1, "description": "| Заблокировано ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "ID": { "type": "integer", "description": "| Идентификатор направления сделки ||" }, "IS_LOCKED": { "type": "string", "maxLength": 1, "description": "| Заблокировано ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.get": { "post": { "summary": "Получить направление сделок crm.dealcategory.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.get](../../universal/category/crm-category-get.md).", "operationId": "crm_dealcategory_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.list": { "post": { "summary": "Отфильтровать направления сделок crm.dealcategory.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.list](../../universal/category/crm-category-list.md).", "operationId": "crm_dealcategory_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.stage.list": { "post": { "summary": "Получить список стадий сделок для направления crm.dealcategory.stage.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.*](../../universal/category/index.md).", "operationId": "crm_dealcategory_stage_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-stage-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления. Если указать `id = 0` или ничего не указывать, то вернёт статусы «дефолтного» направления. Если указать `id > 0` несуществующего направления, ничего не возвращает ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления. Если указать `id = 0` или ничего не указывать, то вернёт статусы «дефолтного» направления. Если указать `id > 0` несуществующего направления, ничего не возвращает ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.status": { "post": { "summary": "Получить идентификатор справочника, где хранятся стадии сделок crm.dealcategory.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.*](../../universal/category/index.md).", "operationId": "crm_dealcategory_status", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.update": { "post": { "summary": "Обновить направление сделок crm.dealcategory.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.category.update](../../universal/category/crm-category-update.md).", "operationId": "crm_dealcategory_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/category-old/crm-deal-category-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления направления сделок." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор направления ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления направления сделок." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dictionary": { "post": { "summary": "Добавить значение справочника CRM v 3.0 crm.dictionary.<справочник>.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_dictionary", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/dictionaries/crm-dictionary-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового значения в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "id": { "type": "string", "description": "| Идентификатор значения, например `SUBSCRIPTION`. Изменить его после создания нельзя." }, "sort": { "type": "integer", "description": "| Порядок сортировки. Ноль и отрицательное значение Битрикс24 заменяет на `10`." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового значения в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "id": { "type": "string", "description": "| Идентификатор значения, например `SUBSCRIPTION`. Изменить его после создания нельзя." }, "sort": { "type": "integer", "description": "| Порядок сортировки. Ноль и отрицательное значение Битрикс24 заменяет на `10`." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.add": { "post": { "summary": "Создать новый документ crm.documentgenerator.document.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.add` создает документ по шаблону для CRM-объекта.", "operationId": "crm_documentgenerator_document_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект со значениями полей документа." }, "stampsEnabled": { "type": "integer", "description": "| Подставлять печать и подпись:" }, "fields": { "type": "object", "description": "| Дополнительные описания полей документа для генерации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект со значениями полей документа." }, "stampsEnabled": { "type": "integer", "description": "| Подставлять печать и подпись:" }, "fields": { "type": "object", "description": "| Дополнительные описания полей документа для генерации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.delete": { "post": { "summary": "Удалить документ crm.documentgenerator.document.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.delete` удаляет документ.", "operationId": "crm_documentgenerator_document_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.enablepublicurl": { "post": { "summary": "Включить или выключить публичную ссылку на документ crm.documentgenerator.document.enablepublicurl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.enablepublicurl` включает или выключает публичную ссылку на документ.", "operationId": "crm_documentgenerator_document_enablepublicurl", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "| Режим публичной ссылки:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "| Режим публичной ссылки:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.get": { "post": { "summary": "Получить документ crm.documentgenerator.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.get` возвращает данные документа по его идентификатору.", "operationId": "crm_documentgenerator_document_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.getfields": { "post": { "summary": "Получить поля документа crm.documentgenerator.document.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.getfields` возвращает карточку полей уже созданного документа: какие поля доступны, их текущие значения, значения по умолчанию и служебные признаки.", "operationId": "crm_documentgenerator_document_getfields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект формата:" }, "DocumentNumber": { "type": "string", "description": "| Номер документа ||" }, "DocumentCreateTime": { "type": "string", "description": "| Дата генерации ||" }, "DocumentTitle": { "type": "string", "description": "| Название документа ||" }, "ClientPhone": { "type": "string", "description": "| Телефон клиента ||" }, "ClientEmail": { "type": "string", "description": "| Email клиента ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Название товара ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Количество ||" }, "TotalSum": { "type": "string", "description": "| Общая сумма ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект формата:" }, "DocumentNumber": { "type": "string", "description": "| Номер документа ||" }, "DocumentCreateTime": { "type": "string", "description": "| Дата генерации ||" }, "DocumentTitle": { "type": "string", "description": "| Название документа ||" }, "ClientPhone": { "type": "string", "description": "| Телефон клиента ||" }, "ClientEmail": { "type": "string", "description": "| Email клиента ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Название товара ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Количество ||" }, "TotalSum": { "type": "string", "description": "| Общая сумма ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.list": { "post": { "summary": "Получить список документов crm.documentgenerator.document.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.list` возвращает список документов по фильтру.", "operationId": "crm_documentgenerator_document_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у документов в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые должны быть заполнены у документов в выборке." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.update": { "post": { "summary": "Обновить документ crm.documentgenerator.document.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.update` обновляет существующий документ.", "operationId": "crm_documentgenerator_document_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект со значениями полей документа." }, "stampsEnabled": { "type": "integer", "description": "| Подставлять печать и подпись:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Объект со значениями полей документа." }, "stampsEnabled": { "type": "integer", "description": "| Подставлять печать и подпись:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.upload": { "post": { "summary": "Загрузить документ crm.documentgenerator.document.upload", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.document.upload` загружает готовый документ и прикрепляет его к CRM-объекту.", "operationId": "crm_documentgenerator_document_upload", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-upload.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pdfContent": { "type": "string", "description": "| Содержимое PDF-файла в формате base64." }, "imageContent": { "type": "string", "description": "| Содержимое изображения в формате base64." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "pdfContent": { "type": "string", "description": "| Содержимое PDF-файла в формате base64." }, "imageContent": { "type": "string", "description": "| Содержимое изображения в формате base64." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.add": { "post": { "summary": "Добавить новый нумератор crm.documentgenerator.numerator.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.numerator.add` создает новый нумератор.", "operationId": "crm_documentgenerator_numerator_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами нумератора формата:" }, "template": { "type": "string", "description": "| Шаблон номера, например `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Настройки генераторов. Описание параметров — ниже. ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации. Описание параметров — ниже ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации. По умолчанию `false` ||" } }, "required": [ "fields", "template" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами нумератора формата:" }, "template": { "type": "string", "description": "| Шаблон номера, например `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Настройки генераторов. Описание параметров — ниже. ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации. Описание параметров — ниже ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации. По умолчанию `false` ||" } }, "required": [ "fields", "template" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.delete": { "post": { "summary": "Удалить нумератор crm.documentgenerator.numerator.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.numerator.delete` удаляет нумератор.", "operationId": "crm_documentgenerator_numerator_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.get": { "post": { "summary": "Получить информацию о нумераторе crm.documentgenerator.numerator.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.numerator.get` возвращает информацию о нумераторе по его идентификатору.", "operationId": "crm_documentgenerator_numerator_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.list": { "post": { "summary": "Получить список нумераторов crm.documentgenerator.numerator.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.numerator.list` возвращает постраничный список нумераторов.", "operationId": "crm_documentgenerator_numerator_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.update": { "post": { "summary": "Изменить нумератор crm.documentgenerator.numerator.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.numerator.update` обновляет существующий нумератор.", "operationId": "crm_documentgenerator_numerator_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "fields": { "type": "object", "description": "| Объект с полями для обновления в формате:" }, "template": { "type": "string", "description": "| Шаблон номера, например `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Настройки генераторов. Описание параметров — ниже ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации. Описание параметров — ниже ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации. По умолчанию `false` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "fields": { "type": "object", "description": "| Объект с полями для обновления в формате:" }, "template": { "type": "string", "description": "| Шаблон номера, например `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Настройки генераторов. Описание параметров — ниже ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации. Описание параметров — ниже ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации. По умолчанию `false` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.add": { "post": { "summary": "Добавить новый шаблон crm.documentgenerator.template.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.add` добавляет новый шаблон документа.", "operationId": "crm_documentgenerator_template_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Массив кодов прав доступа, например `[\"UA\"]`" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона: `Y` или `N`. По умолчанию `Y` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печать и подпись: `Y` или `N`. По умолчанию `N` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Массив кодов прав доступа, например `[\"UA\"]`" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона: `Y` или `N`. По умолчанию `Y` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печать и подпись: `Y` или `N`. По умолчанию `N` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.delete": { "post": { "summary": "Удалить шаблон документа crm.documentgenerator.template.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.delete` удаляет шаблон документа.", "operationId": "crm_documentgenerator_template_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.get": { "post": { "summary": "Получить информацию о шаблоне документа по Id crm.documentgenerator.template.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.get` возвращает информацию о шаблоне по его идентификатору.", "operationId": "crm_documentgenerator_template_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.getfields": { "post": { "summary": "Получить поля шаблона документа crm.documentgenerator.template.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.getfields` возвращает карточку полей шаблона: какие поля доступны, их текущие значения, значения по умолчанию и служебные признаки.", "operationId": "crm_documentgenerator_template_getfields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор CRM-элемента, данные которого будут использованы для вычисления значений полей ||" }, "values": { "type": "object", "description": "| Объект формата:" }, "MyCompanyRequisiteRqCompanyName": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "MyCompanyRequisiteRegisteredAddressText": { "type": "string", "description": "| Полный адрес ||" }, "MyCompanyPhone": { "type": "string", "description": "| Телефон ||" }, "MyCompanyEmail": { "type": "string", "description": "| E-mail ||" }, "MyCompanyWeb": { "type": "string", "description": "| Сайт ||" }, "MyCompanyUfLogo": { "type": "string", "description": "\\| `null` | Логотип ||" }, "RequisiteRqCompanyName": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RequisiteRegisteredAddressText": { "type": "string", "description": "| Полный адрес ||" }, "ClientPhone": { "type": "string", "description": "| Телефон ||" }, "ClientEmail": { "type": "string", "description": "| Email ||" }, "ClientWeb": { "type": "string", "description": "| Сайт ||" }, "DocumentNumber": { "type": "string", "description": "| Номер ||" }, "DocumentCreateTime": { "type": "string", "description": "| Дата генерации ||" }, "ProductsIndex": { "type": "string", "description": "| Текущий номер ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Название ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Количество ||" }, "ProductsProductMeasureName": { "type": "array", "items": {}, "description": "\\| `string` | Единицы измерения ||" }, "ProductsProductPriceRaw": { "type": "array", "items": {}, "description": "\\| `string` | Исходная цена ||" }, "ProductsProductPriceRawSum": { "type": "array", "items": {}, "description": "\\| `string` | Сумма исходной цены ||" }, "TotalRaw": { "type": "string", "description": "| Сумма исходных цен ||" }, "TaxesTaxTitle": { "type": "array", "items": {}, "description": "\\| `string` | Заголовок ||" }, "TaxesTaxRate": { "type": "array", "items": {}, "description": "\\| `string` | Ставка ||" }, "TaxesTaxValue": { "type": "array", "items": {}, "description": "\\| `string` | Сумма ||" }, "TotalSum": { "type": "string", "description": "| Общая сумма ||" }, "MyCompanyAssignedName": { "type": "string", "description": "| Имя ||" }, "MyCompanyAssignedLastName": { "type": "string", "description": "| Фамилия ||" }, "MyCompanyAssignedPersonalPhone": { "type": "string", "description": "| Телефон ||" }, "MyCompanyAssignedEmail": { "type": "string", "description": "| E-Mail ||" }, "DocumentTitle": { "type": "string", "description": "| Название документа ||" }, "MY_COMPANY": { "type": "array", "items": {}, "description": "| Моя компания ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор CRM-элемента, данные которого будут использованы для вычисления значений полей ||" }, "values": { "type": "object", "description": "| Объект формата:" }, "MyCompanyRequisiteRqCompanyName": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "MyCompanyRequisiteRegisteredAddressText": { "type": "string", "description": "| Полный адрес ||" }, "MyCompanyPhone": { "type": "string", "description": "| Телефон ||" }, "MyCompanyEmail": { "type": "string", "description": "| E-mail ||" }, "MyCompanyWeb": { "type": "string", "description": "| Сайт ||" }, "MyCompanyUfLogo": { "type": "string", "description": "\\| `null` | Логотип ||" }, "RequisiteRqCompanyName": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RequisiteRegisteredAddressText": { "type": "string", "description": "| Полный адрес ||" }, "ClientPhone": { "type": "string", "description": "| Телефон ||" }, "ClientEmail": { "type": "string", "description": "| Email ||" }, "ClientWeb": { "type": "string", "description": "| Сайт ||" }, "DocumentNumber": { "type": "string", "description": "| Номер ||" }, "DocumentCreateTime": { "type": "string", "description": "| Дата генерации ||" }, "ProductsIndex": { "type": "string", "description": "| Текущий номер ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Название ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Количество ||" }, "ProductsProductMeasureName": { "type": "array", "items": {}, "description": "\\| `string` | Единицы измерения ||" }, "ProductsProductPriceRaw": { "type": "array", "items": {}, "description": "\\| `string` | Исходная цена ||" }, "ProductsProductPriceRawSum": { "type": "array", "items": {}, "description": "\\| `string` | Сумма исходной цены ||" }, "TotalRaw": { "type": "string", "description": "| Сумма исходных цен ||" }, "TaxesTaxTitle": { "type": "array", "items": {}, "description": "\\| `string` | Заголовок ||" }, "TaxesTaxRate": { "type": "array", "items": {}, "description": "\\| `string` | Ставка ||" }, "TaxesTaxValue": { "type": "array", "items": {}, "description": "\\| `string` | Сумма ||" }, "TotalSum": { "type": "string", "description": "| Общая сумма ||" }, "MyCompanyAssignedName": { "type": "string", "description": "| Имя ||" }, "MyCompanyAssignedLastName": { "type": "string", "description": "| Фамилия ||" }, "MyCompanyAssignedPersonalPhone": { "type": "string", "description": "| Телефон ||" }, "MyCompanyAssignedEmail": { "type": "string", "description": "| E-Mail ||" }, "DocumentTitle": { "type": "string", "description": "| Название документа ||" }, "MY_COMPANY": { "type": "array", "items": {}, "description": "| Моя компания ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.list": { "post": { "summary": "Получить список шаблонов документов crm.documentgenerator.template.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.list` возвращает список шаблонов документов.", "operationId": "crm_documentgenerator_template_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у шаблонов." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у шаблонов." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.update": { "post": { "summary": "Изменить существующий шаблон документа crm.documentgenerator.template.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.documentgenerator.template.update` обновляет существующий шаблон документа.", "operationId": "crm_documentgenerator_template_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "| Файл шаблона в формате `[\"имя_файла.docx\", \"base64_контент\"]`. Можно передать в `base64` или в `multipart/form-data`. Подробнее: Как загружать файлы ||" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора. Список доступных нумераторов можно получить методом crm.documentgenerator.numerator.list ||" }, "region": { "type": "string", "description": "| Регион шаблона, например `ru` ||" }, "entityTypeId": { "type": "array", "items": {}, "description": "| Массив идентификаторов CRM-объектов, для которых доступен шаблон." }, "users": { "type": "array", "items": {}, "description": "| Массив кодов прав доступа, например `[\"UA\"]`." }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона: `Y` или `N` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печать и подпись: `Y` или `N` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "| Файл шаблона в формате `[\"имя_файла.docx\", \"base64_контент\"]`. Можно передать в `base64` или в `multipart/form-data`. Подробнее: Как загружать файлы ||" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора. Список доступных нумераторов можно получить методом crm.documentgenerator.numerator.list ||" }, "region": { "type": "string", "description": "| Регион шаблона, например `ru` ||" }, "entityTypeId": { "type": "array", "items": {}, "description": "| Массив идентификаторов CRM-объектов, для которых доступен шаблон." }, "users": { "type": "array", "items": {}, "description": "| Массив кодов прав доступа, например `[\"UA\"]`." }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона: `Y` или `N` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печать и подпись: `Y` или `N` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.findbycomm": { "post": { "summary": "Получить лиды, контакты и компании с совпадающими данными crm.duplicate.findbycomm", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.duplicate.findbycomm` возвращает идентификаторы лидов, контактов и компаний, содержащих телефоны или email-адреса из заданного списка. Поиск не учитывает добавочный номер телефона.", "operationId": "crm_duplicate_findbycomm", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-duplicate-find-by-comm.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип коммуникации. Возможные значения:" }, "values": { "type": "string", "description": "| Массив email или телефонов." }, "entity_type": { "type": "string", "description": "| Тип объекта. Возможные значения:" } }, "required": [ "type", "values" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип коммуникации. Возможные значения:" }, "values": { "type": "string", "description": "| Массив email или телефонов." }, "entity_type": { "type": "string", "description": "| Тип объекта. Возможные значения:" } }, "required": [ "type", "values" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.fields": { "post": { "summary": "Получить список полей для поиска дубликатов crm.duplicate.volatileType.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.duplicate.volatileType.fields` возвращает список стандартных и пользовательcких полей, которые можно использовать для поиска дубликатов в лидах, контактах и компаниях.", "operationId": "crm_duplicate_volatileType_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.list": { "post": { "summary": "Получить список нестандартных полей, участвующих в поиске дубликатов crm.duplicate.volatileType.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.duplicate.volatileType.list` возвращает список нестандартных полей, которые уже используются для поиска дубликатов в лидах, контактах и компаниях.", "operationId": "crm_duplicate_volatileType_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.register": { "post": { "summary": "Добавить поле в поиск дубликатов crm.duplicate.volatileType.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.duplicate.volatileType.register` добавляет поле в функционал поиска дубликатов в лидах, контактах или компаниях.", "operationId": "crm_duplicate_volatileType_register", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Возможные значения:" }, "fieldCode": { "type": "string", "description": "| Код поля, который нужно добавить в поиск дубликатов. Например `TITLE`, `RQ.RU.NAME`, `UF_CRM_1750854801`. Получить список доступных полей можно методом crm.duplicate.volatileType.fields ||" } }, "required": [ "entityTypeId", "fieldCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Возможные значения:" }, "fieldCode": { "type": "string", "description": "| Код поля, который нужно добавить в поиск дубликатов. Например `TITLE`, `RQ.RU.NAME`, `UF_CRM_1750854801`. Получить список доступных полей можно методом crm.duplicate.volatileType.fields ||" } }, "required": [ "entityTypeId", "fieldCode" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.unregister": { "post": { "summary": "Удалить поле из поиска дубликатов crm.duplicate.volatileType.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.duplicate.volatileType.unregister` удаляет нестандартное поле из поиска дубликатов.", "operationId": "crm_duplicate_volatileType_unregister", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи о поле, которую нужно удалить. Получить идентификаторы записей добавленных к поиску дубликатов полей можно методом crm.duplicate.volatileType.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи о поле, которую нужно удалить. Получить идентификаторы записей добавленных к поиску дубликатов полей можно методом crm.duplicate.volatileType.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.entity.mergeBatch": { "post": { "summary": "Объединить дубликаты crm.entity.mergeBatch", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.entity.mergeBatch` объединяет несколько элементов в один.", "operationId": "crm_entity_mergeBatch", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-entity-merge-batch.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект с элементами для объединения (подробное описание) ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Возможные значения:" }, "entityIds": { "type": "string", "description": "| Массив идентификаторов элементов, которые необходимо объединить. Минимум два элемента ||" } }, "required": [ "params", "entityTypeId", "entityIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект с элементами для объединения (подробное описание) ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Возможные значения:" }, "entityIds": { "type": "string", "description": "| Массив идентификаторов элементов, которые необходимо объединить. Минимум два элемента ||" } }, "required": [ "params", "entityTypeId", "entityIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitydirection": { "post": { "summary": "Получить элементы перечисления «Направление активности» crm.enum.activitydirection", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitydirection", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitynotifytype": { "post": { "summary": "Получить элементы перечисления «Тип уведомления о начале активности» crm.enum.activitynotifytype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitynotifytype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitypriority": { "post": { "summary": "Получить элементы перечисления «Приоритеты дел» crm.enum.activitypriority", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitypriority", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitystatus": { "post": { "summary": "Получить элементы перечисления «Статус» crm.enum.activitystatus", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitystatus", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitytype": { "post": { "summary": "Получить элементы перечисления «Типы дел» crm.enum.activitytype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitytype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.addresstype": { "post": { "summary": "Получить типы адресов crm.enum.addresstype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.dictionary.addresstype.list](../../rest-v3/dictionaries/crm-dictionary-list-rest-v3.md).", "operationId": "crm_enum_addresstype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-address-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.contenttype": { "post": { "summary": "Получить элементы перечисления «Тип описания» crm.enum.contenttype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Значения перечисления собраны в описании [типов данных CRM](../../../data-types.md#activity-enums), а работу с делами описывает раздел [Дела CRM](../../../timeline/activities/index.md).", "operationId": "crm_enum_contenttype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.fields": { "post": { "summary": "Получить поля элементов перечислений crm.enum.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.dictionary.<справочник>.field.list](../../rest-v3/dictionaries/index.md).", "operationId": "crm_enum_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.getorderownertypes": { "post": { "summary": "Получить типы объектов для привязки заказа crm.enum.getorderownertypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.enum.getorderownertypes` возвращает типы объектов CRM, к которым можно привязать заказ. Например, чтобы связать заказ со сделкой, передайте в параметре `ownerTypeId` метода [crm.orderentity.add](../../universal/order-entity/crm-order-entity-add.md) значение `2` — это `id` типа «Сделка».", "operationId": "crm_enum_getorderownertypes", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.ownertype": { "post": { "summary": "Получить типы объектов CRM crm.enum.ownertype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.dictionary.entitytype.list](../../rest-v3/dictionaries/crm-dictionary-list-rest-v3.md). Короткие коды типов `D`, `L`, `C` метод REST 3.0 не возвращает, для них используйте этот метод.", "operationId": "crm_enum_ownertype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-owner-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.settings.mode": { "post": { "summary": "Получить описание режимов работы CRM crm.enum.settings.mode", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.enum.settings.mode` возвращает список режимов работы CRM: их номера и названия. Этот список пригодится, чтобы показать пользователю название текущего режима вместо номера. Например, метод [crm.settings.mode.get](../../crm-settings-mode-get.md) вернул `1` — в списке этому номеру соответствует «Классическая CRM».", "operationId": "crm_enum_settings_mode", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-settings-mode.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.activate": { "post": { "summary": "Включить CRM-форму crm.form.activate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_activate", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-activate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма включится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма включится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.add": { "post": { "summary": "Создать CRM-форму crm.form.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Настройки формы, подробное описание ||" }, "crm": { "type": "object", "description": "| Настройки CRM. Обязательно поле `entityScheme` — схема CRM, то есть какие объекты создаст заполнение формы. Идентификаторы схем возвращает метод crm.form.configuration.get в ключе `entitySchemes`." }, "active": { "type": "boolean", "description": "| Активность формы." }, "languageId": { "type": "string", "description": "| Язык формы. Список языков возвращает метод crm.form.configuration.get ||" }, "templateId": { "type": "string", "description": "| Сценарий формы. Список сценариев возвращает метод crm.form.scenario.list ||" }, "appearance": { "type": "object", "description": "| Заголовок, описание и кнопка. Поля `title`, `description`, `buttonCaption`, `buttonTextColor`, `buttonBackgroundColor`, `copyrightRemoved` описаны в структуре раздела appearance ||" }, "responsible": { "type": "object", "description": "| Очередь ответственных. Поля `userIds`, `checkWorkTime` описаны в структуре раздела responsible ||" }, "agreements": { "type": "object", "description": "| Соглашения. Поля `enabled`, `items` описаны в структуре раздела agreements ||" }, "submission": { "type": "object", "description": "| Сообщения и перенаправление после отправки. Поля `success`, `failure`, `redirectDelay`, `refill` описаны в структуре раздела submission ||" }, "dependencies": { "type": "array", "items": {}, "description": "| Правила зависимых полей. Элемент — группа правил с полями `logic` и `rules`, у каждого правила есть `condition` и `action`. Описание — в структуре элемента dependencies ||" }, "presetFields": { "type": "array", "items": {}, "description": "| Значения полей CRM, которые форма заполнит автоматически. Элемент с полями `entityName`, `fieldName`, `value` описан в структуре элемента presetFields ||" }, "payment": { "type": "object", "description": "| Оплата после заполнения формы. Поля `enabled`, `disabledPaySystemsId` описаны в структуре раздела payment ||" }, "callback": { "type": "object", "description": "| Обратный звонок после заполнения формы. Поля `enabled`, `from`, `text` описаны в структуре раздела callback ||" }, "analytics": { "type": "object", "description": "| Счетчики веб-аналитики. Поля `googleAnalyticsId`, `googleAnalyticsPageViewEnabled`, `yandexMetricaId` описаны в структуре раздела analytics ||" }, "spamProtection": { "type": "object", "description": "| Защита от спама: поле `enabled` типа `boolean` ||" }, "integrations": { "type": "object", "description": "| Форма в мессенджере и связи с рекламными сервисами. Поля `whatsAppEnabled`, `ads` описаны в структуре раздела integrations ||" }, "type": { "type": "string", "description": "| Тип поля, например `string`, `phone`, `email`. Список типов возвращает метод crm.form.configuration.get в ключе `fieldTypes`." }, "label": { "type": "string", "description": "| Подпись поля ||" }, "required": { "type": "boolean", "description": "| Обязательность поля." }, "multiple": { "type": "boolean", "description": "| Можно ли ввести несколько значений." }, "placeholder": { "type": "string", "description": "| Подсказка внутри пустого поля ||" }, "valueType": { "type": "string", "description": "| Тип значения для полей контактов, например рабочий или мобильный телефон ||" }, "value": { "type": "string", "description": "| Значение по умолчанию ||" } }, "required": [ "fields", "crm" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Настройки формы, подробное описание ||" }, "crm": { "type": "object", "description": "| Настройки CRM. Обязательно поле `entityScheme` — схема CRM, то есть какие объекты создаст заполнение формы. Идентификаторы схем возвращает метод crm.form.configuration.get в ключе `entitySchemes`." }, "active": { "type": "boolean", "description": "| Активность формы." }, "languageId": { "type": "string", "description": "| Язык формы. Список языков возвращает метод crm.form.configuration.get ||" }, "templateId": { "type": "string", "description": "| Сценарий формы. Список сценариев возвращает метод crm.form.scenario.list ||" }, "appearance": { "type": "object", "description": "| Заголовок, описание и кнопка. Поля `title`, `description`, `buttonCaption`, `buttonTextColor`, `buttonBackgroundColor`, `copyrightRemoved` описаны в структуре раздела appearance ||" }, "responsible": { "type": "object", "description": "| Очередь ответственных. Поля `userIds`, `checkWorkTime` описаны в структуре раздела responsible ||" }, "agreements": { "type": "object", "description": "| Соглашения. Поля `enabled`, `items` описаны в структуре раздела agreements ||" }, "submission": { "type": "object", "description": "| Сообщения и перенаправление после отправки. Поля `success`, `failure`, `redirectDelay`, `refill` описаны в структуре раздела submission ||" }, "dependencies": { "type": "array", "items": {}, "description": "| Правила зависимых полей. Элемент — группа правил с полями `logic` и `rules`, у каждого правила есть `condition` и `action`. Описание — в структуре элемента dependencies ||" }, "presetFields": { "type": "array", "items": {}, "description": "| Значения полей CRM, которые форма заполнит автоматически. Элемент с полями `entityName`, `fieldName`, `value` описан в структуре элемента presetFields ||" }, "payment": { "type": "object", "description": "| Оплата после заполнения формы. Поля `enabled`, `disabledPaySystemsId` описаны в структуре раздела payment ||" }, "callback": { "type": "object", "description": "| Обратный звонок после заполнения формы. Поля `enabled`, `from`, `text` описаны в структуре раздела callback ||" }, "analytics": { "type": "object", "description": "| Счетчики веб-аналитики. Поля `googleAnalyticsId`, `googleAnalyticsPageViewEnabled`, `yandexMetricaId` описаны в структуре раздела analytics ||" }, "spamProtection": { "type": "object", "description": "| Защита от спама: поле `enabled` типа `boolean` ||" }, "integrations": { "type": "object", "description": "| Форма в мессенджере и связи с рекламными сервисами. Поля `whatsAppEnabled`, `ads` описаны в структуре раздела integrations ||" }, "type": { "type": "string", "description": "| Тип поля, например `string`, `phone`, `email`. Список типов возвращает метод crm.form.configuration.get в ключе `fieldTypes`." }, "label": { "type": "string", "description": "| Подпись поля ||" }, "required": { "type": "boolean", "description": "| Обязательность поля." }, "multiple": { "type": "boolean", "description": "| Можно ли ввести несколько значений." }, "placeholder": { "type": "string", "description": "| Подсказка внутри пустого поля ||" }, "valueType": { "type": "string", "description": "| Тип значения для полей контактов, например рабочий или мобильный телефон ||" }, "value": { "type": "string", "description": "| Значение по умолчанию ||" } }, "required": [ "fields", "crm" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.configuration.field.get": { "post": { "summary": "Получить поле конфигурации конструктора CRM-форм crm.form.configuration.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_configuration_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-configuration-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.configuration.field.list": { "post": { "summary": "Получить список полей конфигурации конструктора CRM-форм crm.form.configuration.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_configuration_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-configuration-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.configuration.get": { "post": { "summary": "Получить конфигурацию конструктора CRM-форм crm.form.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.deactivate": { "post": { "summary": "Выключить CRM-форму crm.form.deactivate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_deactivate", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-deactivate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма выключится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма выключится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.delete": { "post": { "summary": "Удалить CRM-форму crm.form.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма удалится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" }, "confirmed": { "type": "boolean", "description": "| Подтверждение удаления активной формы." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get. Если передать, форма удалится, только если ее не меняли после чтения. Если не передать, версия не проверяется ||" }, "confirmed": { "type": "boolean", "description": "| Подтверждение удаления активной формы." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.embedding.field.get": { "post": { "summary": "Получить поле вариантов размещения CRM-формы crm.form.embedding.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_embedding_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-embedding-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.embedding.field.list": { "post": { "summary": "Получить список полей вариантов размещения CRM-формы crm.form.embedding.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_embedding_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-embedding-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.embedding.get": { "post": { "summary": "Получить варианты размещения CRM-формы crm.form.embedding.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_embedding_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-embedding-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор CRM-формы." }, "variant": { "type": "string", "description": "| Вариант размещения, который нужно вернуть. Если параметр не передан, метод возвращает все варианты." }, "buttonText": { "type": "string", "description": "| Текст кнопки или ссылки, по которой открывается форма. Значение подставляется только в возвращаемый код и не сохраняется в форме." }, "buttonType": { "type": "string", "description": "| Вид элемента, по которому открывается форма. Значение подставляется только в возвращаемый код и не сохраняется в форме." }, "delay": { "type": "integer", "description": "| Задержка автопоказа формы в секундах. Значение подставляется только в возвращаемый код и не сохраняется в форме." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор CRM-формы." }, "variant": { "type": "string", "description": "| Вариант размещения, который нужно вернуть. Если параметр не передан, метод возвращает все варианты." }, "buttonText": { "type": "string", "description": "| Текст кнопки или ссылки, по которой открывается форма. Значение подставляется только в возвращаемый код и не сохраняется в форме." }, "buttonType": { "type": "string", "description": "| Вид элемента, по которому открывается форма. Значение подставляется только в возвращаемый код и не сохраняется в форме." }, "delay": { "type": "integer", "description": "| Задержка автопоказа формы в секундах. Значение подставляется только в возвращаемый код и не сохраняется в форме." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.embedding.update": { "post": { "summary": "Изменить настройки размещения CRM-формы crm.form.embedding.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_embedding_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-embedding-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор CRM-формы." }, "updatedTime": { "type": "string", "format": "date-time", "description": "| Версия формы — дата последнего изменения в формате ISO 8601, например `2026-10-21T17:48:29+03:00`." }, "fields": { "type": "object", "description": "| Настройки, которые нужно изменить. Непереданные настройки остаются без изменений, чтобы сбросить настройку, передайте для нее `null`. Пустой объект `{}` допустим: в этом случае метод ничего не меняет, подробное описание ||" }, "click.settings": { "type": "object", "description": "| Настройки показа формы по клику, подробное описание ||" }, "auto.settings": { "type": "object", "description": "| Настройки автопоказа формы, подробное описание ||" }, "type": { "type": "string", "description": "| Вид окна формы." }, "position": { "type": "string", "description": "| Положение окна по горизонтали." }, "vertical": { "type": "string", "description": "| Положение окна по вертикали." }, "button": { "type": "object", "description": "| Настройки кнопки, подробное описание ||" }, "use": { "type": "boolean", "description": "| Показывать ли кнопку Битрикс24 на сайте." }, "text": { "type": "string", "description": "| Текст кнопки, не длиннее 255 символов ||" }, "font": { "type": "string", "description": "| Шрифт кнопки." }, "align": { "type": "string", "description": "| Выравнивание кнопки." }, "plain": { "type": "boolean", "description": "| Кнопка без фона." }, "rounded": { "type": "boolean", "description": "| Скругленные углы кнопки." }, "outlined": { "type": "boolean", "description": "| Обводка кнопки." }, "decoration": { "type": "string", "description": "| Подчеркивание текста кнопки, не длиннее 20 символов. В интерфейсе используются значения `dotted` и `solid` ||" }, "color": { "type": "object", "description": "| Цвета кнопки в формате HEX: `#3bc8f5` или с прозрачностью `#3eddffa6`. Допустимы 3, 4, 6 или 8 шестнадцатеричных цифр после `#`:" }, "delay": { "type": "integer", "description": "| Задержка автопоказа в секундах." } }, "required": [ "id", "updatedTime", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор CRM-формы." }, "updatedTime": { "type": "string", "format": "date-time", "description": "| Версия формы — дата последнего изменения в формате ISO 8601, например `2026-10-21T17:48:29+03:00`." }, "fields": { "type": "object", "description": "| Настройки, которые нужно изменить. Непереданные настройки остаются без изменений, чтобы сбросить настройку, передайте для нее `null`. Пустой объект `{}` допустим: в этом случае метод ничего не меняет, подробное описание ||" }, "click.settings": { "type": "object", "description": "| Настройки показа формы по клику, подробное описание ||" }, "auto.settings": { "type": "object", "description": "| Настройки автопоказа формы, подробное описание ||" }, "type": { "type": "string", "description": "| Вид окна формы." }, "position": { "type": "string", "description": "| Положение окна по горизонтали." }, "vertical": { "type": "string", "description": "| Положение окна по вертикали." }, "button": { "type": "object", "description": "| Настройки кнопки, подробное описание ||" }, "use": { "type": "boolean", "description": "| Показывать ли кнопку Битрикс24 на сайте." }, "text": { "type": "string", "description": "| Текст кнопки, не длиннее 255 символов ||" }, "font": { "type": "string", "description": "| Шрифт кнопки." }, "align": { "type": "string", "description": "| Выравнивание кнопки." }, "plain": { "type": "boolean", "description": "| Кнопка без фона." }, "rounded": { "type": "boolean", "description": "| Скругленные углы кнопки." }, "outlined": { "type": "boolean", "description": "| Обводка кнопки." }, "decoration": { "type": "string", "description": "| Подчеркивание текста кнопки, не длиннее 20 символов. В интерфейсе используются значения `dotted` и `solid` ||" }, "color": { "type": "object", "description": "| Цвета кнопки в формате HEX: `#3bc8f5` или с прозрачностью `#3eddffa6`. Допустимы 3, 4, 6 или 8 шестнадцатеричных цифр после `#`:" }, "delay": { "type": "integer", "description": "| Задержка автопоказа в секундах." } }, "required": [ "id", "updatedTime", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.entityfield.field.get": { "post": { "summary": "Получить поле справочника полей CRM-формы crm.form.entityfield.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_entityfield_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-entityfield-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.entityfield.field.list": { "post": { "summary": "Получить список полей справочника полей CRM-формы crm.form.entityfield.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_entityfield_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-entityfield-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.entityfield.list": { "post": { "summary": "Получить поля объектов CRM для CRM-формы crm.form.entityfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_entityfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-entityfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по объектам CRM, поля которых нужно получить. Фильтр обязателен и содержит ровно одно условие по полю `entityName`:" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по объектам CRM, поля которых нужно получить. Фильтр обязателен и содержит ровно одно условие по полю `entityName`:" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.field.get": { "post": { "summary": "Получить поле CRM-формы crm.form.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.field.list": { "post": { "summary": "Получить список полей CRM-формы crm.form.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.get": { "post": { "summary": "Получить CRM-форму crm.form.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.list": { "post": { "summary": "Получить список CRM-форм crm.form.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть." }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора в формате REST 3.0: массив условий `[поле, оператор, значение]`. Подробнее о формате — в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть." }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора в формате REST 3.0: массив условий `[поле, оператор, значение]`. Подробнее о формате — в обзоре REST 3.0." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`." }, "pagination": { "type": "object", "description": "| Постраничная навигация:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.openline.field.get": { "post": { "summary": "Получить поле открытой линии для CRM-формы crm.form.openline.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_openline_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-openline-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.openline.field.list": { "post": { "summary": "Получить список полей открытой линии для CRM-формы crm.form.openline.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_openline_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-openline-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.openline.list": { "post": { "summary": "Получить список открытых линий для CRM-формы crm.form.openline.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_openline_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-openline-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по CRM-форме. Принимает ровно одно условие по полю `formId` с оператором `=`:" }, "order": { "type": "object", "description": "| Сортировка по идентификатору открытой линии. Принимает только поле `id`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по CRM-форме. Принимает ровно одно условие по полю `formId` с оператором `=`:" }, "order": { "type": "object", "description": "| Сортировка по идентификатору открытой линии. Принимает только поле `id`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenario.field.get": { "post": { "summary": "Получить поле сценария CRM-формы crm.form.scenario.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenario_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenario-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenario.field.list": { "post": { "summary": "Получить список полей сценария CRM-формы crm.form.scenario.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenario_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenario-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenario.list": { "post": { "summary": "Получить список сценариев CRM-форм crm.form.scenario.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenario_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenario-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenariocategory.field.get": { "post": { "summary": "Получить поле категории сценариев CRM-форм crm.form.scenariocategory.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenariocategory_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenariocategory-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenariocategory.field.list": { "post": { "summary": "Получить список полей категории сценариев CRM-форм crm.form.scenariocategory.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenariocategory_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenariocategory-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.scenariocategory.list": { "post": { "summary": "Получить список категорий сценариев CRM-форм crm.form.scenariocategory.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_scenariocategory_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/setup/crm-form-scenariocategory-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.sitebutton.field.get": { "post": { "summary": "Получить поле виджета на сайт для CRM-формы crm.form.sitebutton.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_sitebutton_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-sitebutton-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.sitebutton.field.list": { "post": { "summary": "Получить список полей виджета на сайт для CRM-формы crm.form.sitebutton.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_sitebutton_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-sitebutton-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе. Если параметр не передан, метод возвращает все поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.sitebutton.list": { "post": { "summary": "Получить список виджетов на сайт для CRM-формы crm.form.sitebutton.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_form_sitebutton_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/placement/crm-form-sitebutton-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по CRM-форме. Принимает ровно одно условие по полю `formId` с оператором `=`:" }, "order": { "type": "object", "description": "| Сортировка по идентификатору виджета. Принимает только поле `id`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр по CRM-форме. Принимает ровно одно условие по полю `formId` с оператором `=`:" }, "order": { "type": "object", "description": "| Сортировка по идентификатору виджета. Принимает только поле `id`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.update": { "post": { "summary": "Изменить CRM-форму crm.form.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get в формате ISO 8601, например `2026-10-21T17:44:00+03:00` ||" }, "fields": { "type": "object", "description": "| Поля, которые нужно изменить. Формат полей такой же, как в ответе crm.form.get. Описание — в разделе Структура CRM-формы." } }, "required": [ "id", "updatedTime", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор формы." }, "updatedTime": { "type": "string", "description": "| Версия формы — значение `updatedTime` из ответа crm.form.get в формате ISO 8601, например `2026-10-21T17:44:00+03:00` ||" }, "fields": { "type": "object", "description": "| Поля, которые нужно изменить. Формат полей такой же, как в ответе crm.form.get. Описание — в разделе Структура CRM-формы." } }, "required": [ "id", "updatedTime", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.form.validate": { "post": { "summary": "Проверить конфигурацию CRM-формы crm.form.validate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "crm_form_validate", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/form/crm-form-validate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сохраненной формы." }, "fields": { "type": "object", "description": "| Конфигурация формы в том же формате, что в crm.form.add и crm.form.update. Описание полей — в разделе Структура CRM-формы." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сохраненной формы." }, "fields": { "type": "object", "description": "| Конфигурация формы в том же формате, что в crm.form.add и crm.form.update. Описание полей — в разделе Структура CRM-формы." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.add": { "post": { "summary": "Добавить счет crm.invoice.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания счета." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания счета." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.delete": { "post": { "summary": "Удалить счет crm.invoice.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.fields": { "post": { "summary": "Получить поля счета и входящих в него товаров crm.invoice.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор | Только для чтения ||" }, "ACCOUNT_NUMBER": { "type": "string", "description": "| Номер | ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий менеджера | ||" }, "CREATED_BY": { "type": "integer", "description": "| Создано пользователем | Только для чтения ||" }, "CURRENCY": { "type": "string", "description": "| Идентификатор валюты | Только для чтения ||" }, "DATE_BILL": { "type": "string", "format": "date", "description": "| Дата выставления | ||" }, "DATE_INSERT": { "type": "string", "format": "date-time", "description": "| Дата создания | ||" }, "DATE_MARKED": { "type": "string", "format": "date-time", "description": "| Дата отклонения | Указывается, если счёт отклонён ||" }, "DATE_PAY_BEFORE": { "type": "string", "format": "date", "description": "| Срок оплаты | ||" }, "DATE_PAYED": { "type": "string", "format": "date-time", "description": "| Дата перевода в состояние оплаты | Только для чтения ||" }, "DATE_STATUS": { "type": "string", "format": "date-time", "description": "| Дата изменения статуса | Только для чтения ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Дата изменения | Только для чтения ||" }, "EMP_PAYED_ID": { "type": "integer", "description": "| Идентификатор пользователя, который последним перевёл счёт в состояние \"оплачен\" | Только для чтения ||" }, "EMP_STATUS_ID": { "type": "integer", "description": "| Идентификатор пользователя, который последним поменял статус счёта | Только для чтения ||" }, "LID": { "type": "integer", "description": "| Идентификатор сайта | Только для чтения ||" }, "XML_ID": { "type": "string", "description": "| Внешний код | ||" }, "ORDER_TOPIC": { "type": "string", "description": "| Тема | ||" }, "PAY_SYSTEM_ID": { "type": "integer", "description": "| Идентификатор печатной формы | ||" }, "PAY_VOUCHER_DATE": { "type": "string", "format": "date", "description": "| Дата оплаты | Указывается, если счёт оплачен ||" }, "PAY_VOUCHER_NUM": { "type": "string", "description": "| Номер документа оплаты | Указывается, если счёт оплачен ||" }, "PAYED": { "type": "string", "maxLength": 1, "description": "| Признак оплаченности | Только для чтения ||" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа плательщика | ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Сумма | Только для чтения ||" }, "REASON_MARKED": { "type": "string", "description": "| Комментарий статуса | Указывается, если счёт оплачен или отклонён ||" }, "RESPONSIBLE_EMAIL": { "type": "string", "description": "| E-mail ответственного | Только для чтения ||" }, "RESPONSIBLE_ID": { "type": "integer", "description": "| Идентификатор ответственного | ||" }, "RESPONSIBLE_LAST_NAME": { "type": "string", "description": "| Фамилия ответственного | Только для чтения ||" }, "RESPONSIBLE_LOGIN": { "type": "string", "description": "| Логин ответственного | Только для чтения ||" }, "RESPONSIBLE_NAME": { "type": "string", "description": "| Имя ответственного | Только для чтения ||" }, "RESPONSIBLE_PERSONAL_PHOTO": { "type": "integer", "description": "| Идентификатор фото ответственного | Только для чтения ||" }, "RESPONSIBLE_SECOND_NAME": { "type": "string", "description": "| Отчество ответственного | Только для чтения ||" }, "RESPONSIBLE_WORK_POSITION": { "type": "string", "description": "| Должность ответственного | Только для чтения ||" }, "STATUS_ID": { "type": "string", "description": "| Идентификатор статуса | Идентификатор справочника \"INVOICE_STATUS\" ||" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога | Только для чтения ||" }, "UF_COMPANY_ID": { "type": "integer", "description": "| Идентификатор компании | Указывается, если плательщик \"Юридическое лицо\" ||" }, "UF_CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта | Указывается, если плательщик \"Физическое лицо\", либо в качестве контактного лица компании ||" }, "UF_MYCOMPANY_ID": { "type": "integer", "description": "| Идентификатор своей компании | Указывается в качестве компании с реквизитами счёта (привязка к реквизитам устанавливается отдельно) ||" }, "UF_DEAL_ID": { "type": "integer", "description": "| Идентификатор связанной сделки | ||" }, "USER_DESCRIPTION": { "type": "string", "description": "| Комментарий | ||" }, "PR_LOCATION": { "type": "integer", "description": "| Идентификатор местоположения | Обязательное, если используется режим налога на документ ||" }, "INVOICE_PROPERTIES": { "type": "array", "items": {}, "description": "| Список свойств | Если клиент - компания, могут быть указаны ключи (все значения типа string):" }, "PRODUCT_ROWS": { "type": "array", "items": {}, "description": "| Список товарных позиций | Поля товарной позиции:" } }, "required": [ "ACCOUNT_NUMBER", "ORDER_TOPIC", "PAY_SYSTEM_ID", "PERSON_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор | Только для чтения ||" }, "ACCOUNT_NUMBER": { "type": "string", "description": "| Номер | ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий менеджера | ||" }, "CREATED_BY": { "type": "integer", "description": "| Создано пользователем | Только для чтения ||" }, "CURRENCY": { "type": "string", "description": "| Идентификатор валюты | Только для чтения ||" }, "DATE_BILL": { "type": "string", "format": "date", "description": "| Дата выставления | ||" }, "DATE_INSERT": { "type": "string", "format": "date-time", "description": "| Дата создания | ||" }, "DATE_MARKED": { "type": "string", "format": "date-time", "description": "| Дата отклонения | Указывается, если счёт отклонён ||" }, "DATE_PAY_BEFORE": { "type": "string", "format": "date", "description": "| Срок оплаты | ||" }, "DATE_PAYED": { "type": "string", "format": "date-time", "description": "| Дата перевода в состояние оплаты | Только для чтения ||" }, "DATE_STATUS": { "type": "string", "format": "date-time", "description": "| Дата изменения статуса | Только для чтения ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Дата изменения | Только для чтения ||" }, "EMP_PAYED_ID": { "type": "integer", "description": "| Идентификатор пользователя, который последним перевёл счёт в состояние \"оплачен\" | Только для чтения ||" }, "EMP_STATUS_ID": { "type": "integer", "description": "| Идентификатор пользователя, который последним поменял статус счёта | Только для чтения ||" }, "LID": { "type": "integer", "description": "| Идентификатор сайта | Только для чтения ||" }, "XML_ID": { "type": "string", "description": "| Внешний код | ||" }, "ORDER_TOPIC": { "type": "string", "description": "| Тема | ||" }, "PAY_SYSTEM_ID": { "type": "integer", "description": "| Идентификатор печатной формы | ||" }, "PAY_VOUCHER_DATE": { "type": "string", "format": "date", "description": "| Дата оплаты | Указывается, если счёт оплачен ||" }, "PAY_VOUCHER_NUM": { "type": "string", "description": "| Номер документа оплаты | Указывается, если счёт оплачен ||" }, "PAYED": { "type": "string", "maxLength": 1, "description": "| Признак оплаченности | Только для чтения ||" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа плательщика | ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Сумма | Только для чтения ||" }, "REASON_MARKED": { "type": "string", "description": "| Комментарий статуса | Указывается, если счёт оплачен или отклонён ||" }, "RESPONSIBLE_EMAIL": { "type": "string", "description": "| E-mail ответственного | Только для чтения ||" }, "RESPONSIBLE_ID": { "type": "integer", "description": "| Идентификатор ответственного | ||" }, "RESPONSIBLE_LAST_NAME": { "type": "string", "description": "| Фамилия ответственного | Только для чтения ||" }, "RESPONSIBLE_LOGIN": { "type": "string", "description": "| Логин ответственного | Только для чтения ||" }, "RESPONSIBLE_NAME": { "type": "string", "description": "| Имя ответственного | Только для чтения ||" }, "RESPONSIBLE_PERSONAL_PHOTO": { "type": "integer", "description": "| Идентификатор фото ответственного | Только для чтения ||" }, "RESPONSIBLE_SECOND_NAME": { "type": "string", "description": "| Отчество ответственного | Только для чтения ||" }, "RESPONSIBLE_WORK_POSITION": { "type": "string", "description": "| Должность ответственного | Только для чтения ||" }, "STATUS_ID": { "type": "string", "description": "| Идентификатор статуса | Идентификатор справочника \"INVOICE_STATUS\" ||" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Сумма налога | Только для чтения ||" }, "UF_COMPANY_ID": { "type": "integer", "description": "| Идентификатор компании | Указывается, если плательщик \"Юридическое лицо\" ||" }, "UF_CONTACT_ID": { "type": "integer", "description": "| Идентификатор контакта | Указывается, если плательщик \"Физическое лицо\", либо в качестве контактного лица компании ||" }, "UF_MYCOMPANY_ID": { "type": "integer", "description": "| Идентификатор своей компании | Указывается в качестве компании с реквизитами счёта (привязка к реквизитам устанавливается отдельно) ||" }, "UF_DEAL_ID": { "type": "integer", "description": "| Идентификатор связанной сделки | ||" }, "USER_DESCRIPTION": { "type": "string", "description": "| Комментарий | ||" }, "PR_LOCATION": { "type": "integer", "description": "| Идентификатор местоположения | Обязательное, если используется режим налога на документ ||" }, "INVOICE_PROPERTIES": { "type": "array", "items": {}, "description": "| Список свойств | Если клиент - компания, могут быть указаны ключи (все значения типа string):" }, "PRODUCT_ROWS": { "type": "array", "items": {}, "description": "| Список товарных позиций | Поля товарной позиции:" } }, "required": [ "ACCOUNT_NUMBER", "ORDER_TOPIC", "PAY_SYSTEM_ID", "PERSON_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.get": { "post": { "summary": "Получить счет по идентификатору crm.invoice.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.getexternallink": { "post": { "summary": "Получить ссылку на счет crm.invoice.getexternallink", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_getexternallink", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-get-external-link.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.list": { "post": { "summary": "Получить список счетов crm.invoice.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.add": { "post": { "summary": "Добавить настройку для регулярного счета crm.invoice.recurring.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания настройки регулярного счета." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания настройки регулярного счета." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.delete": { "post": { "summary": "Удалить настройку регулярного счета crm.invoice.recurring.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.expose": { "post": { "summary": "Создать новый счет из шаблона crm.invoice.recurring.expose", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_expose", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-expose.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона регулярного счета ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона регулярного счета ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.fields": { "post": { "summary": "Получить полня шаблона регулярного счета crm.invoice.recurring.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор записи в таблице настроек регулярного счета | Только для чтения ||" }, "INVOICE_ID": { "type": "integer", "description": "| ID шаблона счета | Неизменяемое ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности. Значения: Y/N | ||" }, "NEXT_EXECUTION": { "type": "string", "format": "date", "description": "| Дата следующего создания нового счета из шаблона. Рассчитывается системой по указанным параметрам. Если значение пустое, новые счета не создаются | Только для чтения. ||" }, "LAST_EXECUTION": { "type": "string", "format": "date", "description": "| Дата последнего создания нового счета из шаблона | Только для чтения ||" }, "COUNTER_REPEAT": { "type": "integer", "description": "| Количество созданных из шаблона счетов | Только для чтения ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала отсчета при расчете даты следующего создания нового счета | ||" }, "SEND_BILL": { "type": "string", "maxLength": 1, "description": "| Отправлять счет на почту, привязанную к плательщику. Значения: Y/N | ||" }, "EMAIL_ID": { "type": "integer", "description": "| ID поля, содержащего email плательщика | ||" }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Есть ли ограничения по созданию новых счетов | ||" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное число счетов, которое можно создать из этого шаблона | Учитывается, если `IS_LIMIT` равно `T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата, до достижения которой можно создавать счета из этого шаблона | Учитывается, если `IS_LIMIT` равно `D` ||" }, "PARAMS": { "type": "string", "description": "Bitrix24 type: recurring_params" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор записи в таблице настроек регулярного счета | Только для чтения ||" }, "INVOICE_ID": { "type": "integer", "description": "| ID шаблона счета | Неизменяемое ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Флаг активности. Значения: Y/N | ||" }, "NEXT_EXECUTION": { "type": "string", "format": "date", "description": "| Дата следующего создания нового счета из шаблона. Рассчитывается системой по указанным параметрам. Если значение пустое, новые счета не создаются | Только для чтения. ||" }, "LAST_EXECUTION": { "type": "string", "format": "date", "description": "| Дата последнего создания нового счета из шаблона | Только для чтения ||" }, "COUNTER_REPEAT": { "type": "integer", "description": "| Количество созданных из шаблона счетов | Только для чтения ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Дата начала отсчета при расчете даты следующего создания нового счета | ||" }, "SEND_BILL": { "type": "string", "maxLength": 1, "description": "| Отправлять счет на почту, привязанную к плательщику. Значения: Y/N | ||" }, "EMAIL_ID": { "type": "integer", "description": "| ID поля, содержащего email плательщика | ||" }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Есть ли ограничения по созданию новых счетов | ||" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Максимальное число счетов, которое можно создать из этого шаблона | Учитывается, если `IS_LIMIT` равно `T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Дата, до достижения которой можно создавать счета из этого шаблона | Учитывается, если `IS_LIMIT` равно `D` ||" }, "PARAMS": { "type": "string", "description": "Bitrix24 type: recurring_params" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.get": { "post": { "summary": "Получить настройку регулярного счета по идентификатору crm.invoice.recurring.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки шаблона регулярного счета ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки шаблона регулярного счета ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.list": { "post": { "summary": "Получить список настроек регулярных счетов по фильтру crm.invoice.recurring.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.update": { "post": { "summary": "Изменить настройку для регулярного счета crm.invoice.recurring.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_recurring_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-recurring-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки шаблона регулярного счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления настройки." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настройки шаблона регулярного счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления настройки." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.add": { "post": { "summary": "Создать новый статус счета crm.invoice.status.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей статуса счета." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей статуса счета." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.delete": { "post": { "summary": "Удалить статус счета crm.invoice.status.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.fields": { "post": { "summary": "Получить поля статуса счета crm.invoice.status.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, связанной с счетом. Только для чтения ||" }, "ID": { "type": "integer", "description": "| Идентификатор счета. Только для чтения ||" }, "NAME_INIT": { "type": "string", "description": "| Только для чтения ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "STATUS_ID": { "type": "string", "description": "| Статус. Только для чтения ||" }, "SYSTEM": { "type": "string", "maxLength": 1, "description": "| Системный или нет. Только для чтения ||" } }, "required": [ "SORT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, связанной с счетом. Только для чтения ||" }, "ID": { "type": "integer", "description": "| Идентификатор счета. Только для чтения ||" }, "NAME_INIT": { "type": "string", "description": "| Только для чтения ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "STATUS_ID": { "type": "string", "description": "| Статус. Только для чтения ||" }, "SYSTEM": { "type": "string", "maxLength": 1, "description": "| Системный или нет. Только для чтения ||" } }, "required": [ "SORT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.get": { "post": { "summary": "Получить статус счета по идентификатору crm.invoice.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.list": { "post": { "summary": "Получить список статусов счета crm.invoice.status.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.update": { "post": { "summary": "Изменить статус счета crm.invoice.status.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_status_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.invoice.status.fields." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор статуса счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.invoice.status.fields." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.update": { "post": { "summary": "Изменить счет crm.invoice.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления счета." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор счета ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления счета." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.add": { "post": { "summary": "Создать пользовательское поле для счетов crm.invoice.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-user-field-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "string", "description": "| Набор полей - массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий описание пользовательского поля. Полное описание полей можно получить вызовом метода crm.userfield.fields. ||" }, "LIST": { "type": "string", "description": "| Содержит набор значений списка для пользовательских полей типа Список. Указывается при создании/обновлении поля. Каждое значение представляет собой массив с полями:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "string", "description": "| Набор полей - массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий описание пользовательского поля. Полное описание полей можно получить вызовом метода crm.userfield.fields. ||" }, "LIST": { "type": "string", "description": "| Содержит набор значений списка для пользовательских полей типа Список. Указывается при создании/обновлении поля. Каждое значение представляет собой массив с полями:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.delete": { "post": { "summary": "Удалить пользовательское поле счетов crm.invoice.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-user-field-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.get": { "post": { "summary": "Получить пользовательское поле по идентификатору crm.invoice.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-user-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.list": { "post": { "summary": "Получить список пользовательских полей по фильтру crm.invoice.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-user-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.update": { "post": { "summary": "Изменить пользовательское поле crm.invoice.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_invoice_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-invoice-user-field-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор пользовательского поля ||" }, "fields": { "type": "string", "description": "| Набор полей - массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.userfield.fields ||" }, "LIST": { "type": "string", "description": "| Содержит набор значений списка для пользовательских полей типа Список. Указывается при создании/обновлении поля. Каждое значение представляет собой массив с полями:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор пользовательского поля ||" }, "fields": { "type": "string", "description": "| Набор полей - массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.userfield.fields ||" }, "LIST": { "type": "string", "description": "| Содержит набор значений списка для пользовательских полей типа Список. Указывается при создании/обновлении поля. Каждое значение представляет собой массив с полями:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.add": { "post": { "summary": "Создать новый элемент CRM crm.item.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.add](../rest-v3/items/crm-entity-add-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим создать." }, "fields": { "type": "object", "description": "| Объект формата." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим создать." }, "fields": { "type": "object", "description": "| Объект формата." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.batchImport": { "post": { "summary": "Импортировать группу записей crm.item.batchImport", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.batchImport` импортирует до 20 элементов одного типа CRM.", "operationId": "crm_item_batchImport", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/import/crm-item-batch-import.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа CRM, в который нужно импортировать элементы." }, "data": { "type": "array", "items": {}, "description": "| Массив объектов с полями импортируемых элементов (подробное описание) ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе." } }, "required": [ "entityTypeId", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа CRM, в который нужно импортировать элементы." }, "data": { "type": "array", "items": {}, "description": "| Массив объектов с полями импортируемых элементов (подробное описание) ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе." } }, "required": [ "entityTypeId", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delete": { "post": { "summary": "Удалить элемент crm.item.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.delete](../rest-v3/items/crm-entity-delete-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим удалить." }, "id": { "type": "integer", "description": "| Идентификатор элемента, который нужно удалить." } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим удалить." }, "id": { "type": "integer", "description": "| Идентификатор элемента, который нужно удалить." } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delivery.get": { "post": { "summary": "Получить информацию о доставке по id crm.item.delivery.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.delivery.get` возвращает краткую информацию о доставке.", "operationId": "crm_item_delivery_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/delivery/crm-item-delivery-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор доставки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор доставки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delivery.list": { "post": { "summary": "Получить список доставок объекта CRM crm.item.delivery.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.delivery.list` возвращает список доставок конкретного объекта CRM. Доставка — это отгрузка заказа, привязанного к объекту CRM.", "operationId": "crm_item_delivery_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/delivery/crm-item-delivery-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, доставки которого нужно получить. Например, идентификатор сделки ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Доставки есть только у сделок и счетов: для них `entityTypeId` равен `2` и `31` соответственно ||" }, "filter": { "type": "object", "description": "| Фильтр, который сужает выборку доставок объекта CRM (подробное описание) ||" }, "order": { "type": "object", "description": "| Порядок сортировки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, доставки которого нужно получить. Например, идентификатор сделки ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Доставки есть только у сделок и счетов: для них `entityTypeId` равен `2` и `31` соответственно ||" }, "filter": { "type": "object", "description": "| Фильтр, который сужает выборку доставок объекта CRM (подробное описание) ||" }, "order": { "type": "object", "description": "| Порядок сортировки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Установить общую карточку для всех пользователей crm.item.details.configuration.forceCommonScopeForAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.detailpagelayout.setcommonforall](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.md).", "operationId": "crm_item_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.get": { "post": { "summary": "Получить параметры карточки элементов crm.item.details.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.detailpagelayout.get](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.md).", "operationId": "crm_item_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, чью конфигурацию вы хотите получить." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, чью конфигурацию вы хотите получить." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.reset": { "post": { "summary": "Сбросить параметры карточки элементов crm.item.details.configuration.reset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.details.configuration.reset` удаляет сохраненную личную или общую конфигурацию карточки объекта CRM. После сброса личной конфигурации карточка показывается по общей, после сброса общей — по настройкам по умолчанию.", "operationId": "crm_item_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-reset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, чью конфигурацию вы хотите сбросить." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, чью конфигурацию вы хотите сбросить." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.set": { "post": { "summary": "Установить параметры карточки элементов crm.item.details.configuration.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.detailpagelayout.update](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.md).", "operationId": "crm_item_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "data": { "type": "string", "description": "| Массив разделов карточки в порядке вывода (подробное описание)." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого вы хотите установить конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" }, "title": { "type": "string", "description": "| Название раздела. Отображается в карточке элемента ||" }, "type": { "type": "string", "description": "| Тип раздела. Допустимо только значение `section`." }, "elements": { "type": "string", "description": "| Массив полей раздела в порядке вывода (подробное описание)." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` | `Вычисляемое` ||" }, "defaultCountry": { "type": "string", "description": "| `PHONE`" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показана ли кнопка принятия оплаты." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показан ли блок «Оплата и доставка»." } }, "required": [ "entityTypeId", "data", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа объектов CRM ||" }, "data": { "type": "string", "description": "| Массив разделов карточки в порядке вывода (подробное описание)." }, "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого вы хотите установить конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Допустимые значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Возможные значения и их структура описана ниже ||" }, "title": { "type": "string", "description": "| Название раздела. Отображается в карточке элемента ||" }, "type": { "type": "string", "description": "| Тип раздела. Допустимо только значение `section`." }, "elements": { "type": "string", "description": "| Массив полей раздела в порядке вывода (подробное описание)." }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительный список опций для поля ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте `crm.enum.addresstype` | `Вычисляемое` ||" }, "defaultCountry": { "type": "string", "description": "| `PHONE`" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показана ли кнопка принятия оплаты." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Показан ли блок «Оплата и доставка»." } }, "required": [ "entityTypeId", "data", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.fields": { "post": { "summary": "Получить поля элемента crm.item.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чьи поля мы хотим получить." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр используется для управления форматом имен пользовательских полей в ответе." } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чьи поля мы хотим получить." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр используется для управления форматом имен пользовательских полей в ответе." } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.get": { "post": { "summary": "Получить элемент по Id crm.item.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.get](../rest-v3/items/crm-entity-get-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим получить." }, "id": { "type": "integer", "description": "| Идентификатор элемента, чью информацию мы хотим получить." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр используется для управления форматом имен пользовательских полей в ответе." } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим получить." }, "id": { "type": "integer", "description": "| Идентификатор элемента, чью информацию мы хотим получить." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр используется для управления форматом имен пользовательских полей в ответе." } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.import": { "post": { "summary": "Импортировать одну запись crm.item.import", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.import` импортирует один элемент в CRM.", "operationId": "crm_item_import", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/import/crm-item-import.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа CRM, в который нужно импортировать элемент." }, "fields": { "type": "object", "description": "| Значения полей импортируемого элемента (подробное описание) ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе." } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа CRM, в который нужно импортировать элемент." }, "fields": { "type": "object", "description": "| Значения полей импортируемого элемента (подробное описание) ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе." } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.list": { "post": { "summary": "Получить список элементов crm.item.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.list](../rest-v3/items/crm-entity-list-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чьи элементы нужно получить." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые должны быть заполнены у элементов в выборке." }, "filter": { "type": "object", "description": "|" }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чьи элементы нужно получить." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые должны быть заполнены у элементов в выборке." }, "filter": { "type": "object", "description": "|" }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.add": { "post": { "summary": "Добавить оплату crm.item.payment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.add` создает пустую оплату с суммой `0` в сделке или счете. Товары и доставку в оплату добавляют методы [crm.item.payment.product.add](./products-in-payment/crm-item-payment-product-add.md) и [crm.item.payment.delivery.add](./delivery-in-payment/crm-item-payment-delivery-add.md), сумма оплаты при этом пересчитывается автоматически.", "operationId": "crm_item_payment_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Оплаты поддерживают только два типа:" }, "fields": { "type": "object", "description": "| Поля новой оплаты. Поддерживается один ключ:" } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Оплаты поддерживают только два типа:" }, "fields": { "type": "object", "description": "| Поля новой оплаты. Поддерживается один ключ:" } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delete": { "post": { "summary": "Удалить оплату crm.item.payment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.delete` удаляет неоплаченную оплату. Оплаченную оплату удалить нельзя: сначала снимите отметку об оплате методом [crm.item.payment.unpay](./crm-item-payment-unpay.md).", "operationId": "crm_item_payment_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.add": { "post": { "summary": "Добавить позицию доставки в оплату crm.item.payment.delivery.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.delivery.add` добавляет в оплату документ доставки из того же заказа. Позиция создается с количеством `1`, сумма оплаты увеличивается на стоимость доставки. Если документ доставки уже есть в оплате, метод не создает дубль и возвращает `id` существующей позиции.", "operationId": "crm_item_payment_delivery_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "deliveryId": { "type": "string", "description": "| Идентификатор документа доставки. Получить его можно методом crm.item.delivery.list — поле `id` в ответе. Документ доставки должен относиться к тому же заказу, что и оплата ||" } }, "required": [ "paymentId", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "deliveryId": { "type": "string", "description": "| Идентификатор документа доставки. Получить его можно методом crm.item.delivery.list — поле `id` в ответе. Документ доставки должен относиться к тому же заказу, что и оплата ||" } }, "required": [ "paymentId", "deliveryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.delete": { "post": { "summary": "Удалить позицию доставки из оплаты crm.item.payment.delivery.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.delivery.delete` удаляет позицию доставки из оплаты. Сумма оплаты уменьшается на стоимость доставки, а сам документ доставки остается в заказе — его можно снова добавить методом [crm.item.payment.delivery.add](./crm-item-payment-delivery-add.md).", "operationId": "crm_item_payment_delivery_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор позиции доставки в оплате. Получить его можно методом crm.item.payment.delivery.list — поле `id` в ответе ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор позиции доставки в оплате. Получить его можно методом crm.item.payment.delivery.list — поле `id` в ответе ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.list": { "post": { "summary": "Получить список позиций доставки по конкретной оплате crm.item.payment.delivery.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.delivery.list` возвращает все позиции доставки оплаты одним ответом, без постраничной навигации.", "operationId": "crm_item_payment_delivery_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля:" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "paymentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля:" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "paymentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.setDelivery": { "post": { "summary": "Перепривязать позицию доставки к другому документу crm.item.payment.delivery.setDelivery", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.delivery.setDelivery` заменяет документ доставки в позиции оплаты. Позиция сохраняет `id` и количество, сумма оплаты пересчитывается. Прежний документ доставки остается в заказе.", "operationId": "crm_item_payment_delivery_setDelivery", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-set-delivery.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор позиции доставки в оплате. Получить его можно методом crm.item.payment.delivery.list — поле `id` в ответе ||" }, "deliveryId": { "type": "string", "description": "| Идентификатор документа доставки. Получить его можно методом crm.item.delivery.list — поле `id` в ответе. Передавайте документ доставки из того же заказа, что и оплата." } }, "required": [ "id", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор позиции доставки в оплате. Получить его можно методом crm.item.payment.delivery.list — поле `id` в ответе ||" }, "deliveryId": { "type": "string", "description": "| Идентификатор документа доставки. Получить его можно методом crm.item.delivery.list — поле `id` в ответе. Передавайте документ доставки из того же заказа, что и оплата." } }, "required": [ "id", "deliveryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.get": { "post": { "summary": "Получить информацию об оплате crm.item.payment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.get` возвращает статус, сумму и платежную систему оплаты по ее идентификатору.", "operationId": "crm_item_payment_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.list": { "post": { "summary": "Получить список оплат crm.item.payment.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.list` возвращает все оплаты сделки или счета одним ответом, без постраничной навигации.", "operationId": "crm_item_payment_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Оплаты есть только у двух типов:" }, "filter": { "type": "object", "description": "| Фильтр по полям оплаты в формате `{\"поле\": \"значение\"}`. Можно отбирать по полям из ответа метода: `id`, `accountNumber`, `paid`, `datePaid`, `empPaidId`, `paySystemId`, `sum`, `currency`, `paySystemName`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM. Оплаты есть только у двух типов:" }, "filter": { "type": "object", "description": "| Фильтр по полям оплаты в формате `{\"поле\": \"значение\"}`. Можно отбирать по полям из ответа метода: `id`, `accountNumber`, `paid`, `datePaid`, `empPaidId`, `paySystemId`, `sum`, `currency`, `paySystemName`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.pay": { "post": { "summary": "Изменить статус оплаты на «Оплачено» crm.item.payment.pay", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.pay` отмечает оплату оплаченной: устанавливает `paid` в `Y`, записывает в `datePaid` текущие дату и время, а в `empPaidId` — идентификатор пользователя, который вызвал метод. Повторный вызов для оплаченной оплаты возвращает `true` и ничего не меняет.", "operationId": "crm_item_payment_pay", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-pay.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.add": { "post": { "summary": "Добавить товарную позицию в оплату crm.item.payment.product.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.product.add` добавляет в оплату товар из товарной строки сделки или счета. Сумма оплаты увеличивается на цену товара, умноженную на `quantity`.", "operationId": "crm_item_payment_product_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "rowId": { "type": "integer", "description": "| Идентификатор товарной строки сделки или счета, к которым относится оплата. Получить его можно методом crm.item.productrow.list — поле `id` в ответе ||" }, "quantity": { "type": "integer", "description": "| Количество товара — целое число от `1` до нераспределенного остатка товарной строки. Остаток — это количество в товарной строке минус количество этого товара во всех оплатах заказа." } }, "required": [ "paymentId", "rowId", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "rowId": { "type": "integer", "description": "| Идентификатор товарной строки сделки или счета, к которым относится оплата. Получить его можно методом crm.item.productrow.list — поле `id` в ответе ||" }, "quantity": { "type": "integer", "description": "| Количество товара — целое число от `1` до нераспределенного остатка товарной строки. Остаток — это количество в товарной строке минус количество этого товара во всех оплатах заказа." } }, "required": [ "paymentId", "rowId", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.delete": { "post": { "summary": "Удалить товарную позицию из оплаты crm.item.payment.product.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.product.delete` удаляет товарную позицию из оплаты. Сумма оплаты уменьшается на стоимость позиции, товарная строка сделки или счета не меняется, а ее количество снова можно добавить в оплату.", "operationId": "crm_item_payment_product_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции в оплате. Получить его можно методом crm.item.payment.product.list — поле `id` в ответе ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции в оплате. Получить его можно методом crm.item.payment.product.list — поле `id` в ответе ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.list": { "post": { "summary": "Получить список товарных позиций оплаты crm.item.payment.product.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.product.list` возвращает все товарные позиции оплаты одним ответом, без постраничной навигации.", "operationId": "crm_item_payment_product_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля:" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "paymentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля:" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" } }, "required": [ "paymentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.setQuantity": { "post": { "summary": "Изменить количество товара crm.item.payment.product.setQuantity", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.product.setQuantity` изменяет количество товара в товарной позиции оплаты. Сумма оплаты пересчитывается автоматически.", "operationId": "crm_item_payment_product_setQuantity", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-set-quantity.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции в оплате. Получить его можно методом crm.item.payment.product.list — поле `id` в ответе ||" }, "quantity": { "type": "integer", "description": "| Новое количество товара — целое число больше `0`. Сумма количеств этого товара во всех оплатах заказа не должна превышать количество в товарной строке сделки или счета ||" } }, "required": [ "id", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции в оплате. Получить его можно методом crm.item.payment.product.list — поле `id` в ответе ||" }, "quantity": { "type": "integer", "description": "| Новое количество товара — целое число больше `0`. Сумма количеств этого товара во всех оплатах заказа не должна превышать количество в товарной строке сделки или счета ||" } }, "required": [ "id", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.unpay": { "post": { "summary": "Изменить статус оплаты на «Не оплачено» crm.item.payment.unpay", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.unpay` снимает с оплаты отметку об оплате: устанавливает `paid` в `N`. Оплата не удаляется, поля `datePaid` и `empPaidId` сохраняют значения последнего проведения. Удалить оплату можно методом [crm.item.payment.delete](./crm-item-payment-delete.md).", "operationId": "crm_item_payment_unpay", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-unpay.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.update": { "post": { "summary": "Изменить поля оплаты crm.item.payment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.item.payment.update` изменяет статус оплаты и платежную систему. Остальные поля оплаты можно изменить методом [sale.payment.update](../../../sale/payment/sale-payment-update.md).", "operationId": "crm_item_payment_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/crm-item-payment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "fields": { "type": "object", "description": "| Поля оплаты, которые нужно изменить (подробное описание). Непереданные поля сохраняют текущие значения ||" }, "paid": { "type": "string", "description": "| Статус оплаты:" }, "paySystemId": { "type": "string", "description": "| Идентификатор платежной системы. Получить список платежных систем можно методом sale.paysystem.list." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "fields": { "type": "object", "description": "| Поля оплаты, которые нужно изменить (подробное описание). Непереданные поля сохраняют текущие значения ||" }, "paid": { "type": "string", "description": "| Статус оплаты:" }, "paySystemId": { "type": "string", "description": "| Идентификатор платежной системы. Получить список платежных систем можно методом sale.paysystem.list." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.add": { "post": { "summary": "Добавить товарную позицию в объект CRM crm.item.productrow.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.add](../../rest-v3/product-rows/crm-entity-product-row-add-rest-v3.md).", "operationId": "crm_item_productrow_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для добавления товарной позиции в объект CRM (подробное описание) ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM ||" }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога." }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара." }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "ownerId", "ownerType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект, содержащий значения полей для добавления товарной позиции в объект CRM (подробное описание) ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM ||" }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога." }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара." }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "ownerId", "ownerType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.delete": { "post": { "summary": "Удалить товарную позицию из объекта CRM crm.item.productrow.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.delete](../../rest-v3/product-rows/crm-entity-product-row-delete-rest-v3.md).", "operationId": "crm_item_productrow_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.fields": { "post": { "summary": "Получить список полей товарных позиций crm.item.productrow.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.field.list](../../rest-v3/product-rows/index.md).", "operationId": "crm_item_productrow_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.get": { "post": { "summary": "Получить информацию о товарной позиции по id crm.item.productrow.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.get](../../rest-v3/product-rows/crm-entity-product-row-get-rest-v3.md).", "operationId": "crm_item_productrow_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.getAvailableForPayment": { "post": { "summary": "Получить неоплаченные товарные позиции объекта CRM crm.item.productrow.getAvailableForPayment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.getavailableforpayment](../../rest-v3/product-rows/crm-entity-product-row-get-available-for-payment-rest-v3.md).", "operationId": "crm_item_productrow_getAvailableForPayment", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-get-available-for-payment.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс. Например, для типа с `entityTypeId: 128` код — `T80` ||" } }, "required": [ "ownerId", "ownerType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс. Например, для типа с `entityTypeId: 128` код — `T80` ||" } }, "required": [ "ownerId", "ownerType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.list": { "post": { "summary": "Получить товарные позиции объекта CRM crm.item.productrow.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.list](../../rest-v3/product-rows/crm-entity-product-row-list-rest-v3.md).", "operationId": "crm_item_productrow_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` (подробное описание) ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных товарных позиций в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "string", "description": "| Идентификатор товарной позиции ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` (подробное описание) ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных товарных позиций в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "string", "description": "| Идентификатор товарной позиции ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.set": { "post": { "summary": "Сохранить товарные позиции объекта CRM crm.item.productrow.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.replace](../../rest-v3/product-rows/crm-entity-product-row-replace-rest-v3.md).", "operationId": "crm_item_productrow_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM ||" }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс ||" }, "productRows": { "type": "string", "description": "| Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте (подробное описание) ||" }, "id": { "type": "string", "description": "| Идентификатор существующей товарной позиции. Получить его можно методом crm.item.productrow.list." }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога." }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара." }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "ownerId", "ownerType", "productRows" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM ||" }, "ownerType": { "type": "string", "description": "| Краткий символьный код типа объекта CRM: `L` — лид, `D` — сделка, `Q` — предложение, `SI` — новый счет, `T` и шестнадцатеричный идентификатор типа — смарт-процесс ||" }, "productRows": { "type": "string", "description": "| Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте (подробное описание) ||" }, "id": { "type": "string", "description": "| Идентификатор существующей товарной позиции. Получить его можно методом crm.item.productrow.list." }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога." }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара." }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "ownerId", "ownerType", "productRows" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.update": { "post": { "summary": "Изменить товарную позицию объекта CRM crm.item.productrow.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.productrow.update](../../rest-v3/product-rows/crm-entity-product-row-update-rest-v3.md).", "operationId": "crm_item_productrow_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/product-rows/crm-item-productrow-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления товарной позиции объекта CRM (подробное описание) ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога ||" }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект, содержащий значения полей для обновления товарной позиции объекта CRM (подробное описание) ||" }, "productId": { "type": "string", "description": "| Идентификатор товара из каталога ||" }, "productName": { "type": "string", "description": "| Название товара в товарной позиции." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "taxIncluded": { "type": "string", "description": "| Индикатор того, включен ли налог в стоимость." }, "taxName": { "type": "string", "description": "| Название налоговой ставки. Например, `НДС 20`." }, "measureCode": { "type": "string", "description": "| Код единицы измерения." }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.update": { "post": { "summary": "Обновить элемент crm.item.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.update](../rest-v3/items/crm-entity-update-rest-v3.md). Для документов CRM и документов КЭДО аналога в REST 3.0 пока нет, для них используйте этот метод.", "operationId": "crm_item_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/crm-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим изменить." }, "fields": { "type": "object", "description": "| Объект формата" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор системного или пользовательского типа, чей элемент мы хотим изменить." }, "fields": { "type": "object", "description": "| Объект формата" }, "useOriginalUfNames": { "type": "boolean", "description": "| Параметр для управления форматом имен пользовательских полей в запросе и ответе." } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.add": { "post": { "summary": "Создать новый лид crm.lead.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.add](../rest-v3/items/crm-entity-add-rest-v3.md).", "operationId": "crm_lead_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Необязательный массив опций (`\"optionName\"=>\"value\"[, ...]`). Перечень возможных полей описан ниже ||" }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "COMMENTS": { "type": "string", "description": "| Комментарии ||" }, "COMPANY_ID": { "type": "string", "description": "| Привязка лида к компании ||" }, "COMPANY_TITLE": { "type": "string", "description": "| Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID ||" }, "CONTACT_ID": { "type": "string", "description": "| Привязка лида к контакту ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к лиду контактов." }, "CURRENCY_ID": { "type": "string", "description": "| Идентификатор валюты ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты. Множественное ||" }, "HONORIFIC": { "type": "string", "description": "| Вид обращения ||" }, "IM": { "type": "string", "description": "| Мессенджер. Множественное ||" }, "LINK": { "type": "string", "description": "| ID пользователя, привязанного через открытую линию. Множественное ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Признак доступности лида для всех. Допустимые значения `Y` или `N`.||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Признак ручного режима расчёта суммы. Допустимые значения Y или N||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "PHONE": { "type": "string", "description": "| Телефон. Множественное ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Описание источника ||" }, "SOURCE_ID": { "type": "string", "description": "| Идентификатор источника." }, "STATUS_DESCRIPTION": { "type": "string", "description": "| Дополнительно о стадии ||" }, "STATUS_ID": { "type": "string", "description": "| Идентификатор стадии лида. Стадии по умолчанию:" }, "TITLE": { "type": "string", "description": "| Название лида ||" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. CPC (объявления), CPM (баннеры) ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система. Yandex-Direct, Google-Adwords и другие ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "WEB": { "type": "string", "description": "| Сайт. Множественное ||" }, "UF_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Флаг `Y`/`N` - произвести регистрацию события добавления лида. Дополнительно будет отправлено уведомление ответственному за лид ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Необязательный массив опций (`\"optionName\"=>\"value\"[, ...]`). Перечень возможных полей описан ниже ||" }, "ADDRESS": { "type": "string", "description": "| Адрес ||" }, "ADDRESS_2": { "type": "string", "description": "| Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части ||" }, "ADDRESS_CITY": { "type": "string", "description": "| Город ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Страна ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Код страны ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Почтовый индекс ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Область ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Район ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Ответственный ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Дата рождения ||" }, "COMMENTS": { "type": "string", "description": "| Комментарии ||" }, "COMPANY_ID": { "type": "string", "description": "| Привязка лида к компании ||" }, "COMPANY_TITLE": { "type": "string", "description": "| Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID ||" }, "CONTACT_ID": { "type": "string", "description": "| Привязка лида к контакту ||" }, "CONTACT_IDS": { "type": "string", "description": "| Список привязанных к лиду контактов." }, "CURRENCY_ID": { "type": "string", "description": "| Идентификатор валюты ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты. Множественное ||" }, "HONORIFIC": { "type": "string", "description": "| Вид обращения ||" }, "IM": { "type": "string", "description": "| Мессенджер. Множественное ||" }, "LINK": { "type": "string", "description": "| ID пользователя, привязанного через открытую линию. Множественное ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Признак доступности лида для всех. Допустимые значения `Y` или `N`.||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Признак ручного режима расчёта суммы. Допустимые значения Y или N||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор источника данных." }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику ||" }, "PHONE": { "type": "string", "description": "| Телефон. Множественное ||" }, "POST": { "type": "string", "description": "| Должность ||" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Описание источника ||" }, "SOURCE_ID": { "type": "string", "description": "| Идентификатор источника." }, "STATUS_DESCRIPTION": { "type": "string", "description": "| Дополнительно о стадии ||" }, "STATUS_ID": { "type": "string", "description": "| Идентификатор стадии лида. Стадии по умолчанию:" }, "TITLE": { "type": "string", "description": "| Название лида ||" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Обозначение рекламной кампании ||" }, "UTM_CONTENT": { "type": "string", "description": "| Содержание кампании. Например, для контекстных объявлений ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Тип трафика. CPC (объявления), CPM (баннеры) ||" }, "UTM_SOURCE": { "type": "string", "description": "| Рекламная система. Yandex-Direct, Google-Adwords и другие ||" }, "UTM_TERM": { "type": "string", "description": "| Условие поиска кампании. Например, ключевые слова контекстной рекламы ||" }, "WEB": { "type": "string", "description": "| Сайт. Множественное ||" }, "UF_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_25534736`." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Флаг `Y`/`N` - произвести регистрацию события добавления лида. Дополнительно будет отправлено уведомление ответственному за лид ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.address.set": { "post": { "summary": "Записать адрес лида v 3.0 crm.lead.address.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_lead_address_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/addresses/crm-lead-address-set-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." }, "fields": { "type": "object", "description": "| Объект с полями адреса в формате `{\"поле\": \"значение\"}`. Передайте хотя бы одно поле. Описание параметра ||" }, "address1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "address2": { "type": "string", "description": "| Квартира или офис ||" }, "city": { "type": "string", "description": "| Город ||" }, "postalCode": { "type": "string", "description": "| Почтовый индекс ||" }, "region": { "type": "string", "description": "| Район ||" }, "province": { "type": "string", "description": "| Область ||" }, "country": { "type": "string", "description": "| Страна ||" }, "countryCode": { "type": "string", "description": "| Код страны из справочника местоположений Битрикс24. Сохраняется, только если совпадает с названием страны в `country` на языке Битрикс24. Иначе метод сохраняет адрес без кода страны и ошибку не возвращает ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." }, "fields": { "type": "object", "description": "| Объект с полями адреса в формате `{\"поле\": \"значение\"}`. Передайте хотя бы одно поле. Описание параметра ||" }, "address1": { "type": "string", "description": "| Улица, дом, корпус, строение ||" }, "address2": { "type": "string", "description": "| Квартира или офис ||" }, "city": { "type": "string", "description": "| Город ||" }, "postalCode": { "type": "string", "description": "| Почтовый индекс ||" }, "region": { "type": "string", "description": "| Район ||" }, "province": { "type": "string", "description": "| Область ||" }, "country": { "type": "string", "description": "| Страна ||" }, "countryCode": { "type": "string", "description": "| Код страны из справочника местоположений Битрикс24. Сохраняется, только если совпадает с названием страны в `country` на языке Битрикс24. Иначе метод сохраняет адрес без кода страны и ошибку не возвращает ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.add": { "post": { "summary": "Добавить привязку контакта к лиду crm.lead.contact.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.addfieldvalue](../../rest-v3/items/crm-entity-add-field-value-rest-v3.md) с полем `contactsId`. Основной контакт назначает метод [crm.lead.setprimarycontact](../../rest-v3/items/crm-entity-set-primary-contact-rest-v3.md). Позицию контакта `SORT` метод REST 3.0 не принимает, для нее используйте этот метод.", "operationId": "crm_lead_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о контакте, который нужно привязать к лиду." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно привязать к лиду." }, "SORT": { "type": "integer", "description": "| Индекс сортировки." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли контакт основным для лида. Возможные значения:" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о контакте, который нужно привязать к лиду." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно привязать к лиду." }, "SORT": { "type": "integer", "description": "| Индекс сортировки." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли контакт основным для лида. Возможные значения:" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.delete": { "post": { "summary": "Удалить привязку контакта к лиду crm.lead.contact.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.deletefieldvalue](../../rest-v3/items/crm-entity-delete-field-value-rest-v3.md). Передайте в метод поле `contactsId` и идентификатор, который нужно удалить из привязок.", "operationId": "crm_lead_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно убрать из привязок." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно убрать из привязок лида. Должен быть больше `0`." } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно убрать из привязок." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно убрать из привязок лида. Должен быть больше `0`." } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.fields": { "post": { "summary": "Получить поля связи лид-контакт crm.lead.contact.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.lead.contact.fields` возвращает описание полей для связи лид-контакт.", "operationId": "crm_lead_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.delete": { "post": { "summary": "Удалить список контактов у лида crm.lead.contact.items.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.update](../../rest-v3/items/crm-entity-update-rest-v3.md). Чтобы удалить все привязки, передайте пустой массив `contactsId: []`.", "operationId": "crm_lead_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-items-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.get": { "post": { "summary": "Получить список связанных контактов crm.lead.contact.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.get](../../rest-v3/items/crm-entity-get-rest-v3.md). Привязки возвращает поле `contactsId`, основную привязку — поле `contactId`.", "operationId": "crm_lead_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.set": { "post": { "summary": "Прикрепить список контактов к лиду crm.lead.contact.items.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.update](../../rest-v3/items/crm-entity-update-rest-v3.md) с массивом `contactsId`: основным станет первый контакт массива. Явные `SORT` и `IS_PRIMARY` метод не принимает, для них используйте этот метод.", "operationId": "crm_lead_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/management-communication/crm-lead-contact-items-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты лида. Структуру объекта привязки смотрите ниже." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно привязать к лиду." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли контакт основным для лида. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида. Должен быть больше `0`." }, "items": { "type": "string", "description": "| Набор объектов, которые описывают контакты лида. Структуру объекта привязки смотрите ниже." }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно привязать к лиду." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Сделать ли контакт основным для лида. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки." } }, "required": [ "id", "items", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.delete": { "post": { "summary": "Удалить лид crm.lead.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.delete](../rest-v3/items/crm-entity-delete-rest-v3.md).", "operationId": "crm_lead_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Установить общую карточку для всех пользователей crm.lead.details.configuration.forceCommonScopeForAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.detailpagelayout.setcommonforall](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.md).", "operationId": "crm_lead_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/custom-form/crm-lead-details-configuration-force-common-scope-for-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "leadCustomerType": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "leadCustomerType": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.get": { "post": { "summary": "Получить параметры карточки crm.lead.details.configuration.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.detailpagelayout.get](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.md).", "operationId": "crm_lead_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/custom-form/crm-lead-details-configuration-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно получить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Структура описана ниже ||" }, "lead.customer.type": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно получить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры. Структура описана ниже ||" }, "lead.customer.type": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.reset": { "post": { "summary": "Сбросить параметры карточки crm.lead.details.configuration.reset", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md).", "operationId": "crm_lead_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/custom-form/crm-lead-details-configuration-reset.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно сбросить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "lead.customer.type": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно сбросить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "lead.customer.type": { "type": "integer", "description": "| Тип лида. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.set": { "post": { "summary": "Установить параметры карточки crm.lead.details.configuration.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.detailpagelayout.update](../../rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.md).", "operationId": "crm_lead_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/custom-form/crm-lead-details-configuration-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "description": "| Список разделов карточки. Каждый раздел содержит набор полей, которые будут выведены в карточке лида ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно сохранить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "title": { "type": "string", "description": "| Заголовок раздела ||" }, "type": { "type": "string", "description": "| Тип раздела. Поддерживается только значение `'section'` ||" }, "elements": { "type": "string", "description": "| Список полей, которые отображаются в разделе ||" }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительные опции поля. Набор опций зависит от типа поля ||" }, "leadCustomerType": { "type": "integer", "description": "| Тип лида. Возможные значения:" } }, "required": [ "data", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "description": "| Список разделов карточки. Каждый раздел содержит набор полей, которые будут выведены в карточке лида ||" }, "userId": { "type": "string", "description": "| Идентификатор пользователя, для которого нужно сохранить личную конфигурацию." }, "scope": { "type": "string", "description": "| Область применения настроек. Возможные значения:" }, "extras": { "type": "object", "description": "| Дополнительные параметры для выбора типа лида. Структура описана ниже ||" }, "title": { "type": "string", "description": "| Заголовок раздела ||" }, "type": { "type": "string", "description": "| Тип раздела. Поддерживается только значение `'section'` ||" }, "elements": { "type": "string", "description": "| Список полей, которые отображаются в разделе ||" }, "optionFlags": { "type": "integer", "description": "| Нужно ли показывать поле всегда:" }, "options": { "type": "object", "description": "| Дополнительные опции поля. Набор опций зависит от типа поля ||" }, "leadCustomerType": { "type": "integer", "description": "| Тип лида. Возможные значения:" } }, "required": [ "data", "title", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.disable": { "post": { "summary": "Выключить лиды в CRM v 3.0 crm.lead.disable", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_lead_disable", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/lead-mode/crm-lead-disable-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.enable": { "post": { "summary": "Включить лиды в CRM v 3.0 crm.lead.enable", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_lead_enable", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/lead-mode/crm-lead-enable-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.fields": { "post": { "summary": "Получить поля лида crm.lead.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Варианты значений полей-списков возвращает метод [crm.lead.field.custom.enum.list](../rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.md).", "operationId": "crm_lead_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.get": { "post": { "summary": "Получить лид по Id crm.lead.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.get](../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_lead_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.isenabled": { "post": { "summary": "Проверить, включены ли лиды в CRM v 3.0 crm.lead.isenabled", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_lead_isenabled", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/lead-mode/crm-lead-is-enabled-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.list": { "post": { "summary": "Получить список лидов crm.lead.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.list](../rest-v3/items/crm-entity-list-rest-v3.md).", "operationId": "crm_lead_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля лида crm-lead-fields)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных лидов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля лида crm-lead-fields)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных лидов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.productrows.get": { "post": { "summary": "Получить товары лида crm.lead.productrows.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.productrow.list](../rest-v3/product-rows/crm-entity-product-row-list-rest-v3.md).", "operationId": "crm_lead_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-productrows-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.productrows.set": { "post": { "summary": "Установить товары в лид crm.lead.productrows.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.productrow.replace](../rest-v3/product-rows/crm-entity-product-row-replace-rest-v3.md).", "operationId": "crm_lead_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-productrows-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Товарные позиции" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. Можно получить список товаров с помощью метода `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции. Если передан `PRODUCT_ID`, то название будет взято у товара" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.)" }, "SORT": { "type": "integer", "description": "| Сортировка" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Товарные позиции" }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге. Можно получить список товаров с помощью метода `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции. Если передан `PRODUCT_ID`, то название будет взято у товара" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Стоимость за единицу с учетом скидок, без учета налогов ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок и налогов ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Стоимость за единицу без учета скидок, но с учетом налогов ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах (если используется тип скидки с процентным значением)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки (если используется тип скидки с абсолютным значением)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Индикатор того, включен ли налог в стоимость" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.)" }, "SORT": { "type": "integer", "description": "| Сортировка" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.update": { "post": { "summary": "Изменить лид crm.lead.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.update](../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_lead_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/crm-lead-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "|Необязательный набор опций. (`\"paramName\"=>\"value\"[, ...]`). Перечень возможных полей описан ниже ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор лида." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "|Необязательный набор опций. (`\"paramName\"=>\"value\"[, ...]`). Перечень возможных полей описан ниже ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.add": { "post": { "summary": "Создать пользовательское поле для лидов crm.lead.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.custom.add](../../rest-v3/fields/crm-entity-field-custom-add-rest-v3.md). Поля типов «Список» `enumeration` и «Файл» `file` метод REST 3.0 не создает, для них используйте этот метод.", "operationId": "crm_lead_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/userfield/crm-lead-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах лидов." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля. Уникальный в пределах лидов." }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.delete": { "post": { "summary": "Удалить пользовательское поле лидов crm.lead.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.custom.delete](../../rest-v3/fields/crm-entity-field-custom-delete-rest-v3.md).", "operationId": "crm_lead_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/userfield/crm-lead-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к лиду." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к лиду." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.get": { "post": { "summary": "Получить пользовательское поле лидов по id crm.lead.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.custom.get](../../rest-v3/fields/crm-entity-field-custom-get-rest-v3.md).", "operationId": "crm_lead_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/userfield/crm-lead-userfield-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к лиду." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, привязанного к лиду." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.list": { "post": { "summary": "Получить список пользовательских полей лидов crm.lead.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.custom.list](../../rest-v3/fields/crm-entity-field-custom-list-rest-v3.md).", "operationId": "crm_lead_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/userfield/crm-lead-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "boolean", "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "boolean", "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.update": { "post": { "summary": "Изменить существующее пользовательское поле лидов crm.lead.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.field.custom.update](../../rest-v3/fields/crm-entity-field-custom-update-rest-v3.md).", "operationId": "crm_lead_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/leads/userfield/crm-lead-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Для каждого типа поля `USER_TYPE_ID` существует свой пул доступных настроек, они описаны ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Показывать ли пользовательское поле в списке." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "boolean", "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.add": { "post": { "summary": "Добавить единицу измерения crm.measure.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.add](../../../catalog/measure/catalog-measure-add.md).", "operationId": "crm_measure_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей единицы измерения." }, "CODE": { "type": "integer", "description": "| Код ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Наименование единицы измерения ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Условное обозначение ||" }, "SYMBOL_INTL": { "type": "string", "description": "| Условное обозначение (международное) ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| Кодовое буквенное обозначение (международное) ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| По умолчанию ||" } }, "required": [ "fields", "CODE", "MEASURE_TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей единицы измерения." }, "CODE": { "type": "integer", "description": "| Код ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Наименование единицы измерения ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Условное обозначение ||" }, "SYMBOL_INTL": { "type": "string", "description": "| Условное обозначение (международное) ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| Кодовое буквенное обозначение (международное) ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| По умолчанию ||" } }, "required": [ "fields", "CODE", "MEASURE_TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.delete": { "post": { "summary": "Удалить единицу измерения crm.measure.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.delete](../../../catalog/measure/catalog-measure-delete.md).", "operationId": "crm_measure_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.fields": { "post": { "summary": "Получить доступные поля единицы измерения crm.measure.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.getFields](../../../catalog/measure/catalog-measure-get-fields.md).", "operationId": "crm_measure_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "integer", "description": "| Код единицы | Обязательное ||" }, "ID": { "type": "integer", "description": "| Идентификатор | Только для чтения ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| По умолчанию | ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Наименование единицы измерения | Обязательное ||" }, "SYMBOL_INTL": { "type": "string", "description": "| Условное обозначение (международное) | ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| Кодовое буквенное обозначение (международное) | ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Условное обозначение | ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "integer", "description": "| Код единицы | Обязательное ||" }, "ID": { "type": "integer", "description": "| Идентификатор | Только для чтения ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| По умолчанию | ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Наименование единицы измерения | Обязательное ||" }, "SYMBOL_INTL": { "type": "string", "description": "| Условное обозначение (международное) | ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| Кодовое буквенное обозначение (международное) | ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Условное обозначение | ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.get": { "post": { "summary": "Получить значения полей единицы измерения crm.measure.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.get](../../../catalog/measure/catalog-measure-get.md).", "operationId": "crm_measure_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.list": { "post": { "summary": "Получить список единиц измерения crm.measure.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.list](../../../catalog/measure/catalog-measure-list.md).", "operationId": "crm_measure_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.update": { "post": { "summary": "Изменить единицу измерения crm.measure.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.measure.update](../../../catalog/measure/catalog-measure-update.md).", "operationId": "crm_measure_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/measure/crm-measure-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где обновляемое поле может принимать значения из возвращаемых методом crm.measure.fields." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор единицы измерения ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где обновляемое поле может принимать значения из возвращаемых методом crm.measure.fields." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.multifield.fields": { "post": { "summary": "Получить описание множественных полей crm.multifield.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.multifield.fields` описывает поля объекта [crm_multifield](../../data-types.md#crm_multifield). Такой объект хранит одно значение телефона, e-mail, сайта или мессенджера и состоит из полей `ID`, `TYPE_ID`, `VALUE` и `VALUE_TYPE`. Для каждого поля метод возвращает тип данных, название и признак «только для чтения». Например, по ответу видно, что `VALUE` и `VALUE_TYPE` передаете вы, а `ID` Битрикс24 заполняет сам. Допустимые значения `VALUE_TYPE` метод не возвращает — они собраны в таблице [Значения VALUE_TYPE](#value-type).", "operationId": "crm_multifield_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/multifield/crm-multifield-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.mycompany.basic.get": { "post": { "summary": "Получить реквизиты и контакты моей компании v 3.0 crm.mycompany.basic.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_mycompany_basic_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/items/crm-my-company-basic-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор моей компании. Идентификаторы можно получить методом crm.mycompany.basic.list ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Описание параметра" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор моей компании. Идентификаторы можно получить методом crm.mycompany.basic.list ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Описание параметра" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.mycompany.basic.list": { "post": { "summary": "Получить список моих компаний с реквизитами и контактами v 3.0 crm.mycompany.basic.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "crm_mycompany_basic_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/items/crm-my-company-basic-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть для каждой компании. Описание параметра" }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора компаний. Описание параметра" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Описание параметра" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации: `limit`, `page`, `offset`. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество компаний на странице. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit` ||" }, "offset": { "type": "integer", "description": "| Количество компаний, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть для каждой компании. Описание параметра" }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора компаний. Описание параметра" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Описание параметра" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации: `limit`, `page`, `offset`. Описание параметра" }, "limit": { "type": "integer", "description": "| Количество компаний на странице. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit` ||" }, "offset": { "type": "integer", "description": "| Количество компаний, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.add": { "post": { "summary": "Добавить привязку заказа к объекту CRM crm.orderentity.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.orderentity.add` добавляет привязку заказа к объекту CRM.", "operationId": "crm_orderentity_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/order-entity/crm-order-entity-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM." }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM." }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.deleteByFilter": { "post": { "summary": "Удалить привязку заказа к объекту CRM crm.orderentity.deleteByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.orderentity.deleteByFilter` удаляет привязку заказа к объекту CRM.", "operationId": "crm_orderentity_deleteByFilter", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/order-entity/crm-order-entity-delete-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для удаления привязки (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM." }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для удаления привязки (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM." }, "ownerId": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.getFields": { "post": { "summary": "Получить поля привязки заказа crm.orderentity.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.orderentity.getFields` возвращает список доступных полей привязки заказа. Каждое поле описывается в виде структуры настроек поля [crm_rest_field_description](../../data-types.md#crm_rest_field_description).", "operationId": "crm_orderentity_getFields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/order-entity/crm-order-entity-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.list": { "post": { "summary": "Получить список привязок заказов к объектам CRM crm.orderentity.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.orderentity.list` возвращает список привязок заказов к объектам CRM.", "operationId": "crm_orderentity_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/order-entity/crm-order-entity-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта crm_orderentity)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field_N` — идентификатор поля crm_orderentity." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта crm_orderentity)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field_N` — идентификатор поля crm_orderentity." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.paysystem.fields": { "post": { "summary": "Получить поля для способов оплаты crm.paysystem.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_paysystem_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-pay-system-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.paysystem.list": { "post": { "summary": "Получить список способов оплаты crm.paysystem.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_paysystem_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-pay-system-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.persontype.fields": { "post": { "summary": "Получить поля для типов плательщиков crm.persontype.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_persontype_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-person-type-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.persontype.list": { "post": { "summary": "Получить список типов плательщиков crm.persontype.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [Универсальные методы для счетов](../../universal/invoice.md).", "operationId": "crm_persontype_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/invoice/crm-person-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Поля сортировки ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.add": { "post": { "summary": "Добавить товар crm.product.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.add](../../../catalog/product/catalog-product-add.md).", "operationId": "crm_product_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания товара." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания товара." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.delete": { "post": { "summary": "Удалить товар crm.product.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.delete](../../../catalog/product/catalog-product-delete.md).", "operationId": "crm_product_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.fields": { "post": { "summary": "Получить поля товара crm.product.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.getFieldsByFilter](../../../catalog/product/catalog-product-get-fields-by-filter.md).", "operationId": "crm_product_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активен ||" }, "CATALOG_ID": { "type": "integer", "description": "| Идентификатор каталога ||" }, "CREATED_BY": { "type": "integer", "description": "| Кем создан товар ||" }, "CURRENCY_ID": { "type": "string", "description": "| Идентификатор валюты ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания товара ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Тип описания ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка, поле доступно в старой карточке товара ||" }, "ID": { "type": "integer", "description": "| Идентификатор товара ||" }, "MEASURE": { "type": "integer", "description": "| Единица измерения ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Кем изменён товар ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка для анонса, поле доступно в старой карточке товара ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Цена ||" }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "TIMESTAMP_X": { "type": "string", "format": "date-time", "description": "| Дата изменения товара ||" }, "VAT_ID": { "type": "integer", "description": "| Идентификатор ставки НДС ||" }, "VAT_INCLUDED": { "type": "string", "maxLength": 1, "description": "| НДС включён в цену ||" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активен ||" }, "CATALOG_ID": { "type": "integer", "description": "| Идентификатор каталога ||" }, "CREATED_BY": { "type": "integer", "description": "| Кем создан товар ||" }, "CURRENCY_ID": { "type": "string", "description": "| Идентификатор валюты ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания товара ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Тип описания ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка, поле доступно в старой карточке товара ||" }, "ID": { "type": "integer", "description": "| Идентификатор товара ||" }, "MEASURE": { "type": "integer", "description": "| Единица измерения ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Кем изменён товар ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка для анонса, поле доступно в старой карточке товара ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Цена ||" }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "TIMESTAMP_X": { "type": "string", "format": "date-time", "description": "| Дата изменения товара ||" }, "VAT_ID": { "type": "integer", "description": "| Идентификатор ставки НДС ||" }, "VAT_INCLUDED": { "type": "string", "maxLength": 1, "description": "| НДС включён в цену ||" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.get": { "post": { "summary": "Получить товар по идентификатору crm.product.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.get](../../../catalog/product/catalog-product-get.md).", "operationId": "crm_product_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.list": { "post": { "summary": "Получить список товаров по фильтру crm.product.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.list](../../../catalog/product/catalog-product-list.md).", "operationId": "crm_product_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.add": { "post": { "summary": "Добавить свойство товаров crm.product.property.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.add](../../../catalog/product-property/catalog-product-property-add.md).", "operationId": "crm_product_property_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания свойства товара." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Значения полей для создания свойства товара." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.delete": { "post": { "summary": "Удалить свойство товаров crm.product.property.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.delete](../../../catalog/product-property/catalog-product-property-delete.md).", "operationId": "crm_product_property_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.enumeration.fields": { "post": { "summary": "Получить поля свойства списочного типа crm.product.property.enumeration.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productPropertyEnum.*](../../../catalog/product-property-enum/index.md).", "operationId": "crm_product_property_enumeration_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-enumeration-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.fields": { "post": { "summary": "Получить поля свойства товаров crm.product.property.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.getFields](../../../catalog/product-property/catalog-product-property-get-fields.md).", "operationId": "crm_product_property_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.get": { "post": { "summary": "Получить свойство товаров по идентификатору crm.product.property.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.get](../../../catalog/product-property/catalog-product-property-get.md).", "operationId": "crm_product_property_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор свойства товара ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор свойства товара ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.list": { "post": { "summary": "Получить список свойств товаров crm.product.property.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.list](../../../catalog/product-property/catalog-product-property-list.md).", "operationId": "crm_product_property_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Сортировка ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Сортировка ||" }, "filter": { "type": "string", "description": "| Поля фильтра ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.settings.fields": { "post": { "summary": "Получить поля дополнительных настроек свойств пользовательского типа crm.product.property.settings.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md).", "operationId": "crm_product_property_settings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-settings-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "| Тип свойства ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "| Тип свойства ||" }, "userType": { "type": "string", "description": "| Пользовательский тип свойства ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.types": { "post": { "summary": "Получить список типов свойств товаров crm.product.property.types", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md).", "operationId": "crm_product_property_types", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.update": { "post": { "summary": "Изменить свойство товаров crm.product.property.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.productProperty.update](../../../catalog/product-property/catalog-product-property-update.md).", "operationId": "crm_product_property_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-property-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор свойства товаров ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления свойства товаров." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор свойства товаров ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения полей для обновления свойства товаров." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.update": { "post": { "summary": "Изменить товар crm.product.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.product.update](../../../catalog/product/catalog-product-update.md).", "operationId": "crm_product_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/products/crm-product-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей - массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.product.fields." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товара ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей - массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.product.fields." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productrow.fields": { "post": { "summary": "Получить описания полей товарных позиций crm.productrow.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.productrow.fields](../../universal/product-rows/crm-item-productrow-fields.md).", "operationId": "crm_productrow_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/productrow-old/crm-productrow-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productrow.list": { "post": { "summary": "Получить список свойств заказа crm.productrow.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [crm.item.productrow.list](../../universal/product-rows/crm-item-productrow-list.md).", "operationId": "crm_productrow_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/productrow-old/crm-productrow-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.add": { "post": { "summary": "Добавить новый раздел товаров crm.productsection.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.add](../../../catalog/section/catalog-section-add.md).", "operationId": "crm_productsection_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей раздела товаров." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"поле\"=>\"значение\"[, ...])`, содержащий значения полей раздела товаров." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.delete": { "post": { "summary": "Удалить раздел товаров crm.productsection.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.delete](../../../catalog/section/catalog-section-delete.md).", "operationId": "crm_productsection_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.fields": { "post": { "summary": "Получить поля раздела товаров crm.productsection.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.getFields](../../../catalog/section/catalog-section-get-fields.md).", "operationId": "crm_productsection_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CATALOG_ID": { "type": "integer", "description": "| Идентификатор каталога | Неизменяемое ||" }, "ID": { "type": "integer", "description": "| Идентификатор раздела | Только для чтения ||" }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор привязанного раздела | ||" }, "XML_ID": { "type": "string", "description": "| Символьный код | ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CATALOG_ID": { "type": "integer", "description": "| Идентификатор каталога | Неизменяемое ||" }, "ID": { "type": "integer", "description": "| Идентификатор раздела | Только для чтения ||" }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор привязанного раздела | ||" }, "XML_ID": { "type": "string", "description": "| Символьный код | ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.get": { "post": { "summary": "Получить раздел товаров по идентификатору crm.productsection.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.get](../../../catalog/section/catalog-section-get.md).", "operationId": "crm_productsection_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.list": { "post": { "summary": "Получить список разделов crm.productsection.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.list](../../../catalog/section/catalog-section-list.md).", "operationId": "crm_productsection_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.update": { "post": { "summary": "Изменить раздел товаров crm.productsection.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.section.update](../../../catalog/section/catalog-section-update.md).", "operationId": "crm_productsection_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/product-section/crm-product-section-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.productsection.fields." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор раздела товаров ||" }, "fields": { "type": "array", "items": {}, "description": "| Набор полей — массив вида `array(\"обновляемое поле\"=>\"значение\"[, ...])`, где \"обновляемое поле\" может принимать значения из возвращаемых методом crm.productsection.fields." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.add": { "post": { "summary": "Добавить коммерческое предложение crm.quote.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.add](../rest-v3/items/crm-entity-add-rest-v3.md).", "operationId": "crm_quote_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями коммерческого предложения формата:" }, "params": { "type": "object", "description": "| Объект дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Тема коммерческого предложения" }, "STATUS_ID": { "type": "string", "description": "| Стадия предложения" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта суммы предложения ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма предложения" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор ответственного ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании-клиента ||" }, "CONTACT_IDS": { "type": "string", "description": "| Массив идентификаторов контактов клиента" }, "MYCOMPANY_ID": { "type": "string", "description": "| Идентификатор «вашей компании» для реквизитов продавца ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступно ли предложение для всех. Возможные значения:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа плательщика ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата выставления ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Срок действия предложения ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Название клиента, до `255` символов ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Адрес клиента, до `255` символов ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Email клиента, до `255` символов ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Телефон клиента, до `255` символов ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "IMPORT": { "type": "boolean", "description": "| Режим импорта. Возможные значения:" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создана ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменена ||" } }, "required": [ "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями коммерческого предложения формата:" }, "params": { "type": "object", "description": "| Объект дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Тема коммерческого предложения" }, "STATUS_ID": { "type": "string", "description": "| Стадия предложения" }, "CURRENCY_ID": { "type": "string", "description": "| Валюта суммы предложения ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма предложения" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор ответственного ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании-клиента ||" }, "CONTACT_IDS": { "type": "string", "description": "| Массив идентификаторов контактов клиента" }, "MYCOMPANY_ID": { "type": "string", "description": "| Идентификатор «вашей компании» для реквизитов продавца ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступно ли предложение для всех. Возможные значения:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа плательщика ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата выставления ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Срок действия предложения ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Название клиента, до `255` символов ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Адрес клиента, до `255` символов ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Email клиента, до `255` символов ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Телефон клиента, до `255` символов ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "IMPORT": { "type": "boolean", "description": "| Режим импорта. Возможные значения:" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Кем создана ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Кем изменена ||" } }, "required": [ "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.add": { "post": { "summary": "Добавить контакт к предложению crm.quote.contact.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.addfieldvalue](../../rest-v3/items/crm-entity-add-field-value-rest-v3.md) с полем `contactsId`. Основной контакт назначает метод [crm.quote.setprimarycontact](../../rest-v3/items/crm-entity-set-primary-contact-rest-v3.md). Позицию контакта `SORT` метод REST 3.0 не принимает, для нее используйте этот метод.", "operationId": "crm_quote_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно привязать к предложению (подробное описание) ||" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к предложению" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно привязать к предложению (подробное описание) ||" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к предложению" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.delete": { "post": { "summary": "Удалить контакт из указанного предложения crm.quote.contact.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.deletefieldvalue](../../rest-v3/items/crm-entity-delete-field-value-rest-v3.md). Передайте в метод поле `contactsId` и идентификатор, который нужно удалить из привязок.", "operationId": "crm_quote_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок (подробное описание) ||" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно удалить из привязок" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "fields": { "type": "object", "description": "| Объект с информацией о том, какой контакт нужно удалить из привязок (подробное описание) ||" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который нужно удалить из привязок" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.fields": { "post": { "summary": "Получить поля для связи предложение-контакт crm.quote.contact.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Точной замены для описания полей привязки нет. Для новой разработки описание поля `contactIds` предложения можно получить методом [crm.item.fields](../../universal/crm-item-fields.md) с `entityTypeId = 7`. Он не возвращает описание `CONTACT_ID`, `SORT` и `IS_PRIMARY` отдельных привязок.", "operationId": "crm_quote_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.items.delete": { "post": { "summary": "Удалить набор контактов, связанных с указанным предложением crm.quote.contact.items.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.update](../../rest-v3/items/crm-entity-update-rest-v3.md). Чтобы удалить все привязки, передайте пустой массив `contactsId: []`.", "operationId": "crm_quote_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-items-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.items.get": { "post": { "summary": "Получить набор контактов, связанных с указанным предложением crm.quote.contact.items.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.get](../../rest-v3/items/crm-entity-get-rest-v3.md). Привязки возвращает поле `contactsId`, основную привязку — поле `contactId`.", "operationId": "crm_quote_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-items-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.contact.items.set": { "post": { "summary": "Установить набор контактов, связанных с указанным предложением crm.quote.contact.items.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.update](../../rest-v3/items/crm-entity-update-rest-v3.md) с массивом `contactsId`: основным станет первый контакт массива. Явные `SORT` и `IS_PRIMARY` метод не принимает, для них используйте этот метод.", "operationId": "crm_quote_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/contacts/crm-quote-contact-items-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "items": { "type": "string", "description": "| Набор объектов, которые описывают привязанные к предложению контакты (подробное описание)" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к предложению" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "items", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения" }, "items": { "type": "string", "description": "| Набор объектов, которые описывают привязанные к предложению контакты (подробное описание)" }, "CONTACT_ID": { "type": "string", "description": "| Идентификатор контакта, который будет привязан к предложению" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Является ли привязка первичной. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки" } }, "required": [ "id", "items", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.delete": { "post": { "summary": "Удалить коммерческое предложение crm.quote.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.delete](../rest-v3/items/crm-entity-delete-rest-v3.md).", "operationId": "crm_quote_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.fields": { "post": { "summary": "Получить поля коммерческого предложения crm.quote.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.list](../rest-v3/fields/crm-entity-field-list-rest-v3.md). Варианты значений полей-списков возвращает метод [crm.quote.field.custom.enum.list](../rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.md).", "operationId": "crm_quote_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.get": { "post": { "summary": "Получить коммерческое предложение по идентификатору crm.quote.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.get](../rest-v3/items/crm-entity-get-rest-v3.md).", "operationId": "crm_quote_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.list": { "post": { "summary": "Получить список коммерческих предложений по фильтру crm.quote.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.list](../rest-v3/items/crm-entity-list-rest-v3.md).", "operationId": "crm_quote_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.productrows.get": { "post": { "summary": "Получить товарные позиции предложения crm.quote.productrows.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.productrow.list](../rest-v3/product-rows/crm-entity-product-row-list-rest-v3.md).", "operationId": "crm_quote_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-product-rows-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.productrows.set": { "post": { "summary": "Установить товарные позиции предложения crm.quote.productrows.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.productrow.replace](../rest-v3/product-rows/crm-entity-product-row-replace-rest-v3.md).", "operationId": "crm_quote_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-product-rows-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." }, "rows": { "type": "string", "description": "| Массив товарных позиций." }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге." }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Описание товарной позиции ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки:" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Включен ли налог в стоимость:" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения ||" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." }, "rows": { "type": "string", "description": "| Массив товарных позиций." }, "PRODUCT_ID": { "type": "integer", "description": "| Идентификатор товара в каталоге." }, "PRODUCT_NAME": { "type": "string", "description": "| Наименование товарной позиции ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Описание товарной позиции ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Итоговая стоимость товара за единицу ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Количество единиц товара ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Тип скидки:" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Значение скидки в процентах ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Абсолютное значение скидки ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Ставка налога в процентах ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Включен ли налог в стоимость:" }, "MEASURE_CODE": { "type": "string", "description": "| Код единицы измерения ||" }, "MEASURE_NAME": { "type": "string", "description": "| Текстовое представление единицы измерения ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.update": { "post": { "summary": "Изменить коммерческое предложение crm.quote.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.update](../rest-v3/items/crm-entity-update-rest-v3.md).", "operationId": "crm_quote_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/crm-quote-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Тема коммерческого предложения." }, "STATUS_ID": { "type": "string", "description": "| Стадия предложения." }, "CURRENCY_ID": { "type": "string", "description": "| Валюта суммы предложения ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма предложения ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор ответственного ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании-клиента ||" }, "CONTACT_IDS": { "type": "string", "description": "| Массив идентификаторов контактов клиента." }, "MYCOMPANY_ID": { "type": "string", "description": "| Идентификатор «вашей компании» для реквизитов продавца ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступно ли предложение для всех. Возможные значения:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа клиента ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата выставления ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Срок действия предложения ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Название клиента, до `255` символов ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Адрес клиента, до `255` символов ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Email клиента, до `255` символов ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Телефон клиента, до `255` символов ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей со смарт-процессами." }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Создавать ли запись в истории изменения. Возможные значения:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор коммерческого предложения." }, "fields": { "type": "object", "description": "| Объект формата:" }, "params": { "type": "object", "description": "| Объект дополнительных параметров (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Тема коммерческого предложения." }, "STATUS_ID": { "type": "string", "description": "| Стадия предложения." }, "CURRENCY_ID": { "type": "string", "description": "| Валюта суммы предложения ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Сумма предложения ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Идентификатор ответственного ||" }, "COMPANY_ID": { "type": "string", "description": "| Идентификатор компании-клиента ||" }, "CONTACT_IDS": { "type": "string", "description": "| Массив идентификаторов контактов клиента." }, "MYCOMPANY_ID": { "type": "string", "description": "| Идентификатор «вашей компании» для реквизитов продавца ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Доступно ли предложение для всех. Возможные значения:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа клиента ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Дата выставления ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Срок действия предложения ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Название клиента, до `255` символов ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Адрес клиента, до `255` символов ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Email клиента, до `255` символов ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Телефон клиента, до `255` символов ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "PARENT_ID_...": { "type": "string", "description": "| Поля связей со смарт-процессами." }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Создавать ли запись в истории изменения. Возможные значения:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.add": { "post": { "summary": "Создать пользовательское поле для предложений crm.quote.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.custom.add](../../rest-v3/fields/crm-entity-field-custom-add-rest-v3.md). Поля типов «Список» `enumeration` и «Файл» `file` метод REST 3.0 не создает, для них используйте этот метод.", "operationId": "crm_quote_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/user-field/crm-quote-user-field-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Список типов, доступных в Битрикс24, возвращает метод crm.userfield.types. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля, уникальный среди полей предложений. Из кода Битрикс24 собирает полное имя с префиксом `UF_CRM_`:" }, "LABEL": { "type": "string", "description": "| Название поля. Если `LIST_FILTER_LABEL`, `LIST_COLUMN_LABEL`, `EDIT_FORM_LABEL`, `ERROR_MESSAGE` или `HELP_MESSAGE` не переданы, метод запишет в них `LABEL`." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Множественное ли поле — хранит ли оно несколько значений. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Набор настроек зависит от типа поля `USER_TYPE_ID`, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля. Список типов, доступных в Битрикс24, возвращает метод crm.userfield.types. Возможные значения:" }, "FIELD_NAME": { "type": "string", "description": "| Код поля, уникальный среди полей предложений. Из кода Битрикс24 собирает полное имя с префиксом `UF_CRM_`:" }, "LABEL": { "type": "string", "description": "| Название поля. Если `LIST_FILTER_LABEL`, `LIST_COLUMN_LABEL`, `EDIT_FORM_LABEL`, `ERROR_MESSAGE` или `HELP_MESSAGE` не переданы, метод запишет в них `LABEL`." }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Множественное ли поле — хранит ли оно несколько значений. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Набор настроек зависит от типа поля `USER_TYPE_ID`, описание ниже ||" }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля." }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.delete": { "post": { "summary": "Удалить пользовательское поле предложений crm.quote.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.custom.delete](../../rest-v3/fields/crm-entity-field-custom-delete-rest-v3.md).", "operationId": "crm_quote_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/user-field/crm-quote-user-field-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля предложений." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля предложений." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.get": { "post": { "summary": "Получить пользовательское поле предложений по ID crm.quote.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.custom.get](../../rest-v3/fields/crm-entity-field-custom-get-rest-v3.md).", "operationId": "crm_quote_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/user-field/crm-quote-user-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля предложений." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля предложений." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.list": { "post": { "summary": "Получить список пользовательских полей предложений crm.quote.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.custom.list](../../rest-v3/fields/crm-entity-field-custom-list-rest-v3.md).", "operationId": "crm_quote_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/user-field/crm-quote-user-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Полное имя поля с префиксом `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Режим поля в фильтре списка:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. Если передать `LANG`, метод вернет подписи поля на этом языке:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Полное имя поля с префиксом `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле множественным." }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли пользовательское поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Режим поля в фильтре списка:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "LANG": { "type": "string", "description": "| Языковой идентификатор. Если передать `LANG`, метод вернет подписи поля на этом языке:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.update": { "post": { "summary": "Изменить существующее пользовательское поле предложений crm.quote.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.quote.field.custom.update](../../rest-v3/fields/crm-entity-field-custom-update-rest-v3.md).", "operationId": "crm_quote_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/quote/user-field/crm-quote-user-field-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Набор настроек зависит от типа поля `USER_TYPE_ID`, описание ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "ID": { "type": "integer", "description": "| Идентификатор существующего элемента списка ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEL": { "type": "string", "maxLength": 1, "description": "| Чтобы удалить элемент с переданным `ID`, передайте `Y` ||" }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект формата:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Является ли поле обязательным. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в фильтре. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные параметры поля. Набор настроек зависит от типа поля `USER_TYPE_ID`, описание ниже." }, "LIST": { "type": "string", "description": "| Список возможных значений для пользовательского поля типа `enumeration`, описание ниже ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Обязательно больше нуля ||" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли поле в списке." }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске." }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись фильтра в списке." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Заголовок в списке." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Сообщение об ошибке. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Помощь. Строка и `lang_map` обрабатываются так же, как у `LIST_FILTER_LABEL` ||" }, "ID": { "type": "integer", "description": "| Идентификатор существующего элемента списка ||" }, "VALUE": { "type": "string", "description": "| Значение элемента списка." }, "DEL": { "type": "string", "maxLength": 1, "description": "| Чтобы удалить элемент с переданным `ID`, передайте `Y` ||" }, "DEF": { "type": "string", "maxLength": 1, "description": "| Является ли элемент списка значением по умолчанию. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.add": { "post": { "summary": "Добавить реквизит crm.requisite.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.add](../../rest-v3/requisites/crm-entity-requisite-add-rest-v3.md). Пользовательские поля реквизита в REST 3.0 пока недоступны.", "operationId": "crm_requisite_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления реквизита (подробное описание) ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта: контакта или компании." }, "PRESET_ID": { "type": "integer", "description": "| Идентификатор шаблона реквизитов." }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ, используется для операций обмена." }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности." }, "ADDRESS_ONLY": { "type": "string", "maxLength": 1, "description": "| Признак состояния, когда реквизит используется только для хранения адреса." }, "SORT": { "type": "integer", "description": "| Сортировка." }, "RQ_NAME": { "type": "string", "description": "| ФИО ||" }, "RQ_FIRST_NAME": { "type": "string", "description": "| Имя ||" }, "RQ_LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "RQ_SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "RQ_COMPANY_ID": { "type": "string", "description": "| Идентификатор организации ||" }, "RQ_COMPANY_NAME": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RQ_COMPANY_FULL_NAME": { "type": "string", "description": "| Полное наименование организации ||" }, "RQ_COMPANY_REG_DATE": { "type": "string", "description": "| Дата государственной регистрации в строковом формате, например `06.04.2007` ||" }, "RQ_DIRECTOR": { "type": "string", "description": "| Генеральный директор ||" }, "RQ_ACCOUNTANT": { "type": "string", "description": "| Главный бухгалтер ||" }, "RQ_CEO_NAME": { "type": "string", "description": "| ФИО первого руководителя ||" }, "RQ_CEO_WORK_POS": { "type": "string", "description": "| Должность первого руководителя ||" }, "RQ_CONTACT": { "type": "string", "description": "| Контактное лицо ||" }, "RQ_EMAIL": { "type": "string", "description": "| E-Mail ||" }, "RQ_PHONE": { "type": "string", "description": "| Телефон ||" }, "RQ_FAX": { "type": "string", "description": "| Факс ||" }, "RQ_IDENT_TYPE": { "type": "string", "description": "| Способ идентификации. Идентификаторы справочников для доступных стран возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "RQ_IDENT_DOC": { "type": "string", "description": "| Вид документа ||" }, "RQ_IDENT_DOC_SER": { "type": "string", "description": "| Серия ||" }, "RQ_IDENT_DOC_NUM": { "type": "string", "description": "| Номер ||" }, "RQ_IDENT_DOC_PERS_NUM": { "type": "string", "description": "| Личный номер ||" }, "RQ_IDENT_DOC_DATE": { "type": "string", "description": "| Дата выдачи в строковом формате, например `21.02.2015` ||" }, "RQ_IDENT_DOC_ISSUED_BY": { "type": "string", "description": "| Кем выдан ||" }, "RQ_IDENT_DOC_DEP_CODE": { "type": "string", "description": "| Код подразделения ||" }, "RQ_INN": { "type": "string", "description": "| ИНН ||" }, "RQ_KPP": { "type": "string", "description": "| КПП ||" }, "RQ_USRLE": { "type": "string", "description": "| Handelsregisternummer (для страны DE) ||" }, "RQ_IFNS": { "type": "string", "description": "| ИФНС ||" }, "RQ_OGRN": { "type": "string", "description": "| ОГРН ||" }, "RQ_OGRNIP": { "type": "string", "description": "| ОГРНИП ||" }, "RQ_OKPO": { "type": "string", "description": "| ОКПО ||" }, "RQ_OKTMO": { "type": "string", "description": "| ОКТМО ||" }, "RQ_OKVED": { "type": "string", "description": "| ОКВЭД ||" }, "RQ_EDRPOU": { "type": "string", "description": "| ЄДРПОУ ||" }, "RQ_DRFO": { "type": "string", "description": "| ДРФО ||" }, "RQ_KBE": { "type": "string", "description": "| КБЕ ||" }, "RQ_IIN": { "type": "string", "description": "| ИИН ||" }, "RQ_BIN": { "type": "string", "description": "| БИН ||" }, "RQ_ST_CERT_SER": { "type": "string", "description": "| Серия свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_NUM": { "type": "string", "description": "| Номер свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_DATE": { "type": "string", "description": "| Дата свидетельства о государственной регистрации ||" }, "RQ_VAT_PAYER": { "type": "string", "maxLength": 1, "description": "| Платник ПДВ (для страны UA)." }, "RQ_VAT_ID": { "type": "string", "description": "| VAT ID (идентификационный номер (плательщика) НДС) ||" }, "RQ_VAT_CERT_SER": { "type": "string", "description": "| Серия свидетельства по НДС ||" }, "RQ_VAT_CERT_NUM": { "type": "string", "description": "| Номер свидетельства по НДС ||" }, "RQ_VAT_CERT_DATE": { "type": "string", "description": "| Дата свидетельства по НДС ||" }, "RQ_RESIDENCE_COUNTRY": { "type": "string", "description": "| Страна резидента ||" }, "RQ_BASE_DOC": { "type": "string", "description": "| Основание действия ||" }, "RQ_REGON": { "type": "string", "description": "| REGON (для страны PL) ||" }, "RQ_KRS": { "type": "string", "description": "| KRS (для страны PL) ||" }, "RQ_PESEL": { "type": "string", "description": "| PESEL (для страны PL) ||" }, "RQ_LEGAL_FORM": { "type": "string", "description": "| Forme juridique (для страны FR) ||" }, "RQ_SIRET": { "type": "string", "description": "| Numéro Siret (для страны FR) ||" }, "RQ_SIREN": { "type": "string", "description": "| Numéro Siren (для страны FR) ||" }, "RQ_CAPITAL": { "type": "string", "description": "| Capital social (для страны FR) ||" }, "RQ_RCS": { "type": "string", "description": "| RCS (для страны FR) ||" }, "RQ_CNPJ": { "type": "string", "description": "| CNPJ (для страны BR) ||" }, "RQ_STATE_REG": { "type": "string", "description": "| Inscrição Estadual (IE) (для страны BR) ||" }, "RQ_MNPL_REG": { "type": "string", "description": "| Inscrição Municipal (IM) (для страны BR) ||" }, "RQ_CPF": { "type": "string", "description": "| CPF (для страны BR) ||" }, "RQ_TAX_REGIME": { "type": "string", "description": "| Налоговый режим для страны MX. Идентификатор справочника возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_1694526604`." } }, "required": [ "fields", "ENTITY_TYPE_ID", "ENTITY_ID", "PRESET_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления реквизита (подробное описание) ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта: контакта или компании." }, "PRESET_ID": { "type": "integer", "description": "| Идентификатор шаблона реквизитов." }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ, используется для операций обмена." }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности." }, "ADDRESS_ONLY": { "type": "string", "maxLength": 1, "description": "| Признак состояния, когда реквизит используется только для хранения адреса." }, "SORT": { "type": "integer", "description": "| Сортировка." }, "RQ_NAME": { "type": "string", "description": "| ФИО ||" }, "RQ_FIRST_NAME": { "type": "string", "description": "| Имя ||" }, "RQ_LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "RQ_SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "RQ_COMPANY_ID": { "type": "string", "description": "| Идентификатор организации ||" }, "RQ_COMPANY_NAME": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RQ_COMPANY_FULL_NAME": { "type": "string", "description": "| Полное наименование организации ||" }, "RQ_COMPANY_REG_DATE": { "type": "string", "description": "| Дата государственной регистрации в строковом формате, например `06.04.2007` ||" }, "RQ_DIRECTOR": { "type": "string", "description": "| Генеральный директор ||" }, "RQ_ACCOUNTANT": { "type": "string", "description": "| Главный бухгалтер ||" }, "RQ_CEO_NAME": { "type": "string", "description": "| ФИО первого руководителя ||" }, "RQ_CEO_WORK_POS": { "type": "string", "description": "| Должность первого руководителя ||" }, "RQ_CONTACT": { "type": "string", "description": "| Контактное лицо ||" }, "RQ_EMAIL": { "type": "string", "description": "| E-Mail ||" }, "RQ_PHONE": { "type": "string", "description": "| Телефон ||" }, "RQ_FAX": { "type": "string", "description": "| Факс ||" }, "RQ_IDENT_TYPE": { "type": "string", "description": "| Способ идентификации. Идентификаторы справочников для доступных стран возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "RQ_IDENT_DOC": { "type": "string", "description": "| Вид документа ||" }, "RQ_IDENT_DOC_SER": { "type": "string", "description": "| Серия ||" }, "RQ_IDENT_DOC_NUM": { "type": "string", "description": "| Номер ||" }, "RQ_IDENT_DOC_PERS_NUM": { "type": "string", "description": "| Личный номер ||" }, "RQ_IDENT_DOC_DATE": { "type": "string", "description": "| Дата выдачи в строковом формате, например `21.02.2015` ||" }, "RQ_IDENT_DOC_ISSUED_BY": { "type": "string", "description": "| Кем выдан ||" }, "RQ_IDENT_DOC_DEP_CODE": { "type": "string", "description": "| Код подразделения ||" }, "RQ_INN": { "type": "string", "description": "| ИНН ||" }, "RQ_KPP": { "type": "string", "description": "| КПП ||" }, "RQ_USRLE": { "type": "string", "description": "| Handelsregisternummer (для страны DE) ||" }, "RQ_IFNS": { "type": "string", "description": "| ИФНС ||" }, "RQ_OGRN": { "type": "string", "description": "| ОГРН ||" }, "RQ_OGRNIP": { "type": "string", "description": "| ОГРНИП ||" }, "RQ_OKPO": { "type": "string", "description": "| ОКПО ||" }, "RQ_OKTMO": { "type": "string", "description": "| ОКТМО ||" }, "RQ_OKVED": { "type": "string", "description": "| ОКВЭД ||" }, "RQ_EDRPOU": { "type": "string", "description": "| ЄДРПОУ ||" }, "RQ_DRFO": { "type": "string", "description": "| ДРФО ||" }, "RQ_KBE": { "type": "string", "description": "| КБЕ ||" }, "RQ_IIN": { "type": "string", "description": "| ИИН ||" }, "RQ_BIN": { "type": "string", "description": "| БИН ||" }, "RQ_ST_CERT_SER": { "type": "string", "description": "| Серия свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_NUM": { "type": "string", "description": "| Номер свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_DATE": { "type": "string", "description": "| Дата свидетельства о государственной регистрации ||" }, "RQ_VAT_PAYER": { "type": "string", "maxLength": 1, "description": "| Платник ПДВ (для страны UA)." }, "RQ_VAT_ID": { "type": "string", "description": "| VAT ID (идентификационный номер (плательщика) НДС) ||" }, "RQ_VAT_CERT_SER": { "type": "string", "description": "| Серия свидетельства по НДС ||" }, "RQ_VAT_CERT_NUM": { "type": "string", "description": "| Номер свидетельства по НДС ||" }, "RQ_VAT_CERT_DATE": { "type": "string", "description": "| Дата свидетельства по НДС ||" }, "RQ_RESIDENCE_COUNTRY": { "type": "string", "description": "| Страна резидента ||" }, "RQ_BASE_DOC": { "type": "string", "description": "| Основание действия ||" }, "RQ_REGON": { "type": "string", "description": "| REGON (для страны PL) ||" }, "RQ_KRS": { "type": "string", "description": "| KRS (для страны PL) ||" }, "RQ_PESEL": { "type": "string", "description": "| PESEL (для страны PL) ||" }, "RQ_LEGAL_FORM": { "type": "string", "description": "| Forme juridique (для страны FR) ||" }, "RQ_SIRET": { "type": "string", "description": "| Numéro Siret (для страны FR) ||" }, "RQ_SIREN": { "type": "string", "description": "| Numéro Siren (для страны FR) ||" }, "RQ_CAPITAL": { "type": "string", "description": "| Capital social (для страны FR) ||" }, "RQ_RCS": { "type": "string", "description": "| RCS (для страны FR) ||" }, "RQ_CNPJ": { "type": "string", "description": "| CNPJ (для страны BR) ||" }, "RQ_STATE_REG": { "type": "string", "description": "| Inscrição Estadual (IE) (для страны BR) ||" }, "RQ_MNPL_REG": { "type": "string", "description": "| Inscrição Municipal (IM) (для страны BR) ||" }, "RQ_CPF": { "type": "string", "description": "| CPF (для страны BR) ||" }, "RQ_TAX_REGIME": { "type": "string", "description": "| Налоговый режим для страны MX. Идентификатор справочника возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_1694526604`." } }, "required": [ "fields", "ENTITY_TYPE_ID", "ENTITY_ID", "PRESET_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.add": { "post": { "summary": "Создать новый банковский реквизит crm.requisite.bankdetail.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.add](../../rest-v3/requisites/crm-entity-requisite-bank-requisite-add-rest-v3.md).", "operationId": "crm_requisite_bankdetail_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления банковского реквизита ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита. Идентификаторы реквизитов можно получить с помощью метода `crm.requisite.list` ||" }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } }, "required": [ "fields", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления банковского реквизита ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита. Идентификаторы реквизитов можно получить с помощью метода `crm.requisite.list` ||" }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } }, "required": [ "fields", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.delete": { "post": { "summary": "Удалить банковский реквизит crm.requisite.bankdetail.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.delete](../../rest-v3/requisites/crm-entity-requisite-bank-requisite-delete-rest-v3.md).", "operationId": "crm_requisite_bankdetail_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита. Идентификаторы банковских реквизитов можно получить с помощью метода `crm.requisite.bankdetail.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита. Идентификаторы банковских реквизитов можно получить с помощью метода `crm.requisite.bankdetail.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.fields": { "post": { "summary": "Получить описание полей банковских реквизитов crm.requisite.bankdetail.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.field.list](../../rest-v3/requisites/index.md).", "operationId": "crm_requisite_bankdetail_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего реквизит ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего реквизит ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего реквизит ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего реквизит ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.get": { "post": { "summary": "Получить банковский реквизит по id crm.requisite.bankdetail.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.get](../../rest-v3/requisites/crm-entity-requisite-bank-requisite-get-rest-v3.md).", "operationId": "crm_requisite_bankdetail_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.list": { "post": { "summary": "Получить список банковских реквизитов по фильтру crm.requisite.bankdetail.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.list](../../rest-v3/requisites/crm-entity-requisite-bank-requisite-list-rest-v3.md).", "operationId": "crm_requisite_bankdetail_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля банковского реквизита)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных банковских реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных банковских реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего реквизит ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего реквизит ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля банковского реквизита)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных банковских реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных банковских реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего реквизит ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего реквизит ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.update": { "post": { "summary": "Изменить банковский реквизит crm.requisite.bankdetail.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.bankrequisite.update](../../rest-v3/requisites/crm-entity-requisite-bank-requisite-update-rest-v3.md).", "operationId": "crm_requisite_bankdetail_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "fields": { "type": "object", "description": "| Набор полей банковского реквизита — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "fields": { "type": "object", "description": "| Набор полей банковского реквизита — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Наименование банка ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Адрес банка ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Código do banco (для страны BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| БИК ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (для страны FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (для страны FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (для страны FR) ||" }, "RQ_MFO": { "type": "string", "description": "| МФО ||" }, "RQ_ACC_NAME": { "type": "string", "description": "| Bank Account Holder Name ||" }, "RQ_ACC_NUM": { "type": "string", "description": "| Bank Account Number ||" }, "RQ_ACC_TYPE": { "type": "string", "description": "| Tipo da conta (для страны BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (для страны BR) ||" }, "RQ_IIK": { "type": "string", "description": "| ИИК ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Валюта счета ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Корреспондентский счет ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Комментарий ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.delete": { "post": { "summary": "Удалить реквизит и связанные объекты crm.requisite.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.delete](../../rest-v3/requisites/crm-entity-requisite-delete-rest-v3.md).", "operationId": "crm_requisite_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.fields": { "post": { "summary": "Получить поля реквизита crm.requisite.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.field.list](../../rest-v3/requisites/index.md). Пользовательские поля реквизита в REST 3.0 пока недоступны.", "operationId": "crm_requisite_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.get": { "post": { "summary": "Получить реквизит по идентификатору crm.requisite.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.get](../../rest-v3/requisites/crm-entity-requisite-get-rest-v3.md). Пользовательские поля реквизита в REST 3.0 пока недоступны.", "operationId": "crm_requisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.fields": { "post": { "summary": "Получить описание полей связи реквизитов crm.requisite.link.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0 `crm.<тип>.clientrequisite.field.list` и `crm.<тип>.mycompanyrequisite.field.list` из группы [Реквизиты](../../rest-v3/requisites/index.md). Реквизит моей компании методы REST 3.0 выбирают только в сделке и счете, для предложений и смарт-процессов используйте этот метод.", "operationId": "crm_requisite_link_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.get": { "post": { "summary": "Получить связь реквизита с объектом crm.requisite.link.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0 [crm.<тип>.clientrequisite.get](../../rest-v3/requisites/crm-entity-client-requisite-get-rest-v3.md) и [crm.<тип>.mycompanyrequisite.get](../../rest-v3/requisites/crm-entity-my-company-requisite-get-rest-v3.md). Реквизит моей компании методы REST 3.0 выбирают только в сделке и счете, для предложений и смарт-процессов используйте этот метод.", "operationId": "crm_requisite_link_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "|" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "|" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.list": { "post": { "summary": "Получить список связей реквизитов crm.requisite.link.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает список связей реквизитов по фильтру.", "operationId": "crm_requisite_link_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля связи реквизитов)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных связей реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных связей реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля связи реквизитов)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных связей реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных связей реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.register": { "post": { "summary": "Зарегистрировать связь реквизитов с объектом crm.requisite.link.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0 [crm.<тип>.clientrequisite.set](../../rest-v3/requisites/crm-entity-client-requisite-set-rest-v3.md) и [crm.<тип>.mycompanyrequisite.set](../../rest-v3/requisites/crm-entity-my-company-requisite-set-rest-v3.md). Реквизит моей компании методы REST 3.0 выбирают только в сделке и счете, для предложений и смарт-процессов используйте этот метод.", "operationId": "crm_requisite_link_register", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей связи реквизита — объект вида `{\"поле\": \"значение\"[, ...]}` ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." } }, "required": [ "fields", "ENTITY_TYPE_ID", "ENTITY_ID", "REQUISITE_ID", "BANK_DETAIL_ID", "MC_REQUISITE_ID", "MC_BANK_DETAIL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей связи реквизита — объект вида `{\"поле\": \"значение\"[, ...]}` ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." }, "REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита клиента, выбранного для объекта." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита клиента, выбранного для объекта." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Идентификатор реквизита моей компании, выбранного для объекта." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Идентификатор банковского реквизита моей компании, выбранного для объекта." } }, "required": [ "fields", "ENTITY_TYPE_ID", "ENTITY_ID", "REQUISITE_ID", "BANK_DETAIL_ID", "MC_REQUISITE_ID", "MC_BANK_DETAIL_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.unregister": { "post": { "summary": "Удалить связь реквизита с объектом crm.requisite.link.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы REST 3.0 [crm.<тип>.clientrequisite.set](../../rest-v3/requisites/crm-entity-client-requisite-set-rest-v3.md) и [crm.<тип>.mycompanyrequisite.set](../../rest-v3/requisites/crm-entity-my-company-requisite-set-rest-v3.md) с `requisiteId: 0`. Реквизит моей компании методы REST 3.0 выбирают только в сделке и счете, для предложений и смарт-процессов используйте этот метод.", "operationId": "crm_requisite_link_unregister", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "entityId": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта, к которому относится связь." }, "entityId": { "type": "integer", "description": "| Идентификатор объекта, к которому относится связь." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.list": { "post": { "summary": "Получить список реквизитов по фильтру crm.requisite.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.requisite.list](../../rest-v3/requisites/crm-requisite-list-rest-v3.md). Пользовательские поля реквизита в REST 3.0 пока недоступны.", "operationId": "crm_requisite_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать. Описание полей возвращает метод crm.requisite.fields." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать. Описание полей возвращает метод crm.requisite.fields." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных реквизитов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.add": { "post": { "summary": "Создать шаблон crm.requisite.preset.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.requisite.preset.add` создает новый шаблон реквизитов.", "operationId": "crm_requisite_preset_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления шаблона ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries) ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "ENTITY_TYPE_ID", "COUNTRY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления шаблона ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries) ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "ENTITY_TYPE_ID", "COUNTRY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.countries": { "post": { "summary": "Получить список стран для шаблона crm.requisite.preset.countries", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.requisite.preset.countries` возвращает список стран для [шаблонов реквизитов](./index.md). Идентификаторы стран используются в поле `COUNTRY_ID` шаблона.", "operationId": "crm_requisite_preset_countries", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-countries.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.delete": { "post": { "summary": "Удалить шаблон реквизита crm.requisite.preset.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.requisite.preset.delete` удаляет шаблон реквизитов по идентификатору.", "operationId": "crm_requisite_preset_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Можно получить с помощью метода `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Можно получить с помощью метода `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.add": { "post": { "summary": "Добавить настраиваемое поле в шаблон реквизитов crm.requisite.preset.field.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет настраиваемое поле в шаблон реквизитов. С помощью метода [crm.requisite.preset.field.availabletoadd](./crm-requisite-preset-field-available-to-add.md) можно получить поля, доступные для добавления в шаблон.", "operationId": "crm_requisite_preset_field_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления настраиваемого поля шаблона ||" }, "FIELD_NAME": { "type": "string", "description": "| Название поля. ||" }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" } }, "required": [ "preset", "fields", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления настраиваемого поля шаблона ||" }, "FIELD_NAME": { "type": "string", "description": "| Название поля. ||" }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" } }, "required": [ "preset", "fields", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.availabletoadd": { "post": { "summary": "Получить поля, доступные для добавления в шаблон реквизитов crm.requisite.preset.field.availabletoadd", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает поля, доступные для добавления в указанный шаблон реквизитов.", "operationId": "crm_requisite_preset_field_availabletoadd", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, для которого нужно получить список доступных для добавления настраиваемых полей." } }, "required": [ "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, для которого нужно получить список доступных для добавления настраиваемых полей." } }, "required": [ "preset" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.delete": { "post": { "summary": "Удалить настраиваемое поле из шаблона реквизитов crm.requisite.preset.field.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет настраиваемое поле из шаблона реквизитов.", "operationId": "crm_requisite_preset_field_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля, которое нужно удалить." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого удаляется настраиваемое поле (например, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля, которое нужно удалить." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого удаляется настраиваемое поле (например, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.fields": { "post": { "summary": "Получить описание настраиваемых полей шаблона реквизитов crm.requisite.preset.field.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает формально описание полей, описывающих настаиваемое поле шаблона реквизитов.", "operationId": "crm_requisite_preset_field_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор поля. Создается автоматически и уникален в рамках шаблона ||" }, "FIELD_NAME": { "type": "string", "description": "| Название поля ||" }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — идентификатор поля, а `value` — объект с атрибутами поля ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор поля. Создается автоматически и уникален в рамках шаблона ||" }, "FIELD_NAME": { "type": "string", "description": "| Название поля ||" }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" }, "type": { "type": "string", "description": "| Тип поля ||" }, "isRequired": { "type": "boolean", "description": "| Атрибут «обязательное». Возможные значения:" }, "isReadOnly": { "type": "boolean", "description": "| Атрибут «только для чтения». Возможные значения:" }, "isImmutable": { "type": "boolean", "description": "| Атрибут «неизменяемое». Возможные значения:" }, "isMultiple": { "type": "boolean", "description": "| Атрибут «мультиполе». Возможные значения:" }, "isDynamic": { "type": "boolean", "description": "| Атрибут «пользовательское». Возможные значения:" }, "title": { "type": "string", "description": "| Идентификатор поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.get": { "post": { "summary": "Получить настраиваемое поле шаблона реквизитов по id crm.requisite.preset.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.preset.get](../../../rest-v3/requisites/crm-entity-requisite-preset-get-rest-v3.md): поля шаблона приходят в его ответе. Идентификаторы полей шаблона метод не возвращает, для них используйте этот метод.", "operationId": "crm_requisite_preset_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого извлекается информация о настраиваемом поле (например, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого извлекается информация о настраиваемом поле (например, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.list": { "post": { "summary": "Получить список всех настраиваемых полей заданного шаблона реквизитов crm.requisite.preset.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.preset.get](../../../rest-v3/requisites/crm-entity-requisite-preset-get-rest-v3.md): поля шаблона приходят в его ответе. Идентификаторы полей шаблона метод не возвращает, для них используйте этот метод.", "operationId": "crm_requisite_preset_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого извлекается список настраиваемых полей (например, `{\"ID\": 27}`). Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list ||" } }, "required": [ "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, из которого извлекается список настраиваемых полей (например, `{\"ID\": 27}`). Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list ||" } }, "required": [ "preset" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.update": { "post": { "summary": "Изменить настраиваемое поле заданного шаблона реквизитов crm.requisite.preset.field.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод изменяет настраиваемое поле в шаблоне реквизитов.", "operationId": "crm_requisite_preset_field_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля, которое нужно изменить." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| Объект с полями и их значениями, которые нужно изменить. Метод crm.requisite.preset.field.fields позволяет получить описание полей, которые можно менять." }, "FIELD_NAME": { "type": "string", "description": "| Название поля." }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" } }, "required": [ "id", "preset", "fields", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор настраиваемого поля, которое нужно изменить." }, "preset": { "type": "object", "description": "| Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| Объект с полями и их значениями, которые нужно изменить. Метод crm.requisite.preset.field.fields позволяет получить описание полей, которые можно менять." }, "FIELD_NAME": { "type": "string", "description": "| Название поля." }, "FIELD_TITLE": { "type": "string", "description": "| Альтернативное название поля для реквизита." }, "SORT": { "type": "integer", "description": "| Сортировка. Порядок в списке полей шаблона ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N` ||" } }, "required": [ "id", "preset", "fields", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.fields": { "post": { "summary": "Получить описание полей шаблона реквизитов crm.requisite.preset.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 `crm.<тип>.requisite.preset.field.list` из группы [Реквизиты](../../rest-v3/requisites/index.md). Метод REST 3.0 не возвращает поля шаблона `countryId`, `active` и `xmlId` и не фильтрует шаблоны, для этого используйте этот метод.", "operationId": "crm_requisite_preset_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.get": { "post": { "summary": "Получить поля шаблона реквизитов по id crm.requisite.preset.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.preset.get](../../rest-v3/requisites/crm-entity-requisite-preset-get-rest-v3.md). Метод REST 3.0 не возвращает поля шаблона `countryId`, `active` и `xmlId` и не фильтрует шаблоны, для этого используйте этот метод.", "operationId": "crm_requisite_preset_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Можно получить с помощью метода `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Можно получить с помощью метода `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.list": { "post": { "summary": "Получить список шаблонов реквизитов по фильтру crm.requisite.preset.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.preset.list](../../rest-v3/requisites/crm-entity-requisite-preset-list-rest-v3.md). Метод REST 3.0 не возвращает поля шаблона `countryId`, `active` и `xmlId` и не фильтрует шаблоны, для этого используйте этот метод.", "operationId": "crm_requisite_preset_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля шаблона)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных шаблонов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных шаблонов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор шаблона. Создается автоматически и уникален в рамках Битрикс24 ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries) ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения. Содержит пустую строку, если шаблон не менялся после создания ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего шаблон ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего шаблон ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля шаблона)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных шаблонов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных шаблонов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "ID": { "type": "integer", "description": "| Идентификатор шаблона. Создается автоматически и уникален в рамках Битрикс24 ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Идентификатор типа родительского объекта." }, "COUNTRY_ID": { "type": "integer", "description": "| Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries) ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата изменения. Содержит пустую строку, если шаблон не менялся после создания ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, создавшего шаблон ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Идентификатор пользователя, изменившего шаблон ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.update": { "post": { "summary": "Изменить шаблон реквизита crm.requisite.preset.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.requisite.preset.update` изменяет шаблон реквизитов.", "operationId": "crm_requisite_preset_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизитов, который необходимо изменить. Можно получить с помощью метода `crm.requisite.preset.list` ||" }, "fields": { "type": "object", "description": "| Набор полей шаблона — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить. `COUNTRY_ID` и `ENTITY_TYPE_ID` задаются при создании шаблона: переданные в `fields` новые значения этих полей не применяются ||" }, "XML_ID": { "type": "string", "description": "|Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона реквизитов, который необходимо изменить. Можно получить с помощью метода `crm.requisite.preset.list` ||" }, "fields": { "type": "object", "description": "| Набор полей шаблона — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить. `COUNTRY_ID` и `ENTITY_TYPE_ID` задаются при создании шаблона: переданные в `fields` новые значения этих полей не применяются ||" }, "XML_ID": { "type": "string", "description": "|Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.update": { "post": { "summary": "Обновить реквизит crm.requisite.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.<тип>.requisite.update](../../rest-v3/requisites/crm-entity-requisite-update-rest-v3.md). Пользовательские поля реквизита в REST 3.0 пока недоступны.", "operationId": "crm_requisite_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита, можно получить методом crm.requisite.list ||" }, "fields": { "type": "object", "description": "| Набор полей реквизита — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить (подробное описание) ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ, используется для операций обмена." }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности." }, "ADDRESS_ONLY": { "type": "string", "maxLength": 1, "description": "| Признак состояния, когда реквизит используется только для хранения адреса." }, "SORT": { "type": "integer", "description": "| Сортировка." }, "RQ_NAME": { "type": "string", "description": "| ФИО ||" }, "RQ_FIRST_NAME": { "type": "string", "description": "| Имя ||" }, "RQ_LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "RQ_SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "RQ_COMPANY_ID": { "type": "string", "description": "| Идентификатор организации ||" }, "RQ_COMPANY_NAME": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RQ_COMPANY_FULL_NAME": { "type": "string", "description": "| Полное наименование организации ||" }, "RQ_COMPANY_REG_DATE": { "type": "string", "description": "| Дата государственной регистрации в строковом формате, например `06.04.2007` ||" }, "RQ_DIRECTOR": { "type": "string", "description": "| Генеральный директор ||" }, "RQ_ACCOUNTANT": { "type": "string", "description": "| Главный бухгалтер ||" }, "RQ_CEO_NAME": { "type": "string", "description": "| ФИО первого руководителя ||" }, "RQ_CEO_WORK_POS": { "type": "string", "description": "| Должность первого руководителя ||" }, "RQ_CONTACT": { "type": "string", "description": "| Контактное лицо ||" }, "RQ_EMAIL": { "type": "string", "description": "| E-Mail ||" }, "RQ_PHONE": { "type": "string", "description": "| Телефон ||" }, "RQ_FAX": { "type": "string", "description": "| Факс ||" }, "RQ_IDENT_TYPE": { "type": "string", "description": "| Способ идентификации. Идентификаторы справочников для доступных стран возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "RQ_IDENT_DOC": { "type": "string", "description": "| Вид документа ||" }, "RQ_IDENT_DOC_SER": { "type": "string", "description": "| Серия ||" }, "RQ_IDENT_DOC_NUM": { "type": "string", "description": "| Номер ||" }, "RQ_IDENT_DOC_PERS_NUM": { "type": "string", "description": "| Личный номер ||" }, "RQ_IDENT_DOC_DATE": { "type": "string", "description": "| Дата выдачи в строковом формате, например `21.02.2015` ||" }, "RQ_IDENT_DOC_ISSUED_BY": { "type": "string", "description": "| Кем выдан ||" }, "RQ_IDENT_DOC_DEP_CODE": { "type": "string", "description": "| Код подразделения ||" }, "RQ_INN": { "type": "string", "description": "| ИНН ||" }, "RQ_KPP": { "type": "string", "description": "| КПП ||" }, "RQ_USRLE": { "type": "string", "description": "| Handelsregisternummer (для страны DE) ||" }, "RQ_IFNS": { "type": "string", "description": "| ИФНС ||" }, "RQ_OGRN": { "type": "string", "description": "| ОГРН ||" }, "RQ_OGRNIP": { "type": "string", "description": "| ОГРНИП ||" }, "RQ_OKPO": { "type": "string", "description": "| ОКПО ||" }, "RQ_OKTMO": { "type": "string", "description": "| ОКТМО ||" }, "RQ_OKVED": { "type": "string", "description": "| ОКВЭД ||" }, "RQ_EDRPOU": { "type": "string", "description": "| ЄДРПОУ ||" }, "RQ_DRFO": { "type": "string", "description": "| ДРФО ||" }, "RQ_KBE": { "type": "string", "description": "| КБЕ ||" }, "RQ_IIN": { "type": "string", "description": "| ИИН ||" }, "RQ_BIN": { "type": "string", "description": "| БИН ||" }, "RQ_ST_CERT_SER": { "type": "string", "description": "| Серия свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_NUM": { "type": "string", "description": "| Номер свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_DATE": { "type": "string", "description": "| Дата свидетельства о государственной регистрации ||" }, "RQ_VAT_PAYER": { "type": "string", "maxLength": 1, "description": "| Платник ПДВ (для страны UA)." }, "RQ_VAT_ID": { "type": "string", "description": "| VAT ID (идентификационный номер (плательщика) НДС) ||" }, "RQ_VAT_CERT_SER": { "type": "string", "description": "| Серия свидетельства по НДС ||" }, "RQ_VAT_CERT_NUM": { "type": "string", "description": "| Номер свидетельства по НДС ||" }, "RQ_VAT_CERT_DATE": { "type": "string", "description": "| Дата свидетельства по НДС ||" }, "RQ_RESIDENCE_COUNTRY": { "type": "string", "description": "| Страна резидента ||" }, "RQ_BASE_DOC": { "type": "string", "description": "| Основание действия ||" }, "RQ_REGON": { "type": "string", "description": "| REGON (для страны PL) ||" }, "RQ_KRS": { "type": "string", "description": "| KRS (для страны PL) ||" }, "RQ_PESEL": { "type": "string", "description": "| PESEL (для страны PL) ||" }, "RQ_LEGAL_FORM": { "type": "string", "description": "| Forme juridique (для страны FR) ||" }, "RQ_SIRET": { "type": "string", "description": "| Numéro Siret (для страны FR) ||" }, "RQ_SIREN": { "type": "string", "description": "| Numéro Siren (для страны FR) ||" }, "RQ_CAPITAL": { "type": "string", "description": "| Capital social (для страны FR) ||" }, "RQ_RCS": { "type": "string", "description": "| RCS (для страны FR) ||" }, "RQ_CNPJ": { "type": "string", "description": "| CNPJ (для страны BR) ||" }, "RQ_STATE_REG": { "type": "string", "description": "| Inscrição Estadual (IE) (для страны BR) ||" }, "RQ_MNPL_REG": { "type": "string", "description": "| Inscrição Municipal (IM) (для страны BR) ||" }, "RQ_CPF": { "type": "string", "description": "| CPF (для страны BR) ||" }, "RQ_TAX_REGIME": { "type": "string", "description": "| Налоговый режим для страны MX. Идентификатор справочника возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_1694526604`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита, можно получить методом crm.requisite.list ||" }, "fields": { "type": "object", "description": "| Набор полей реквизита — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить (подробное описание) ||" }, "CODE": { "type": "string", "description": "| Символьный код реквизита ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ, используется для операций обмена." }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор внешней информационной базы." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Признак активности." }, "ADDRESS_ONLY": { "type": "string", "maxLength": 1, "description": "| Признак состояния, когда реквизит используется только для хранения адреса." }, "SORT": { "type": "integer", "description": "| Сортировка." }, "RQ_NAME": { "type": "string", "description": "| ФИО ||" }, "RQ_FIRST_NAME": { "type": "string", "description": "| Имя ||" }, "RQ_LAST_NAME": { "type": "string", "description": "| Фамилия ||" }, "RQ_SECOND_NAME": { "type": "string", "description": "| Отчество ||" }, "RQ_COMPANY_ID": { "type": "string", "description": "| Идентификатор организации ||" }, "RQ_COMPANY_NAME": { "type": "string", "description": "| Сокращенное наименование организации ||" }, "RQ_COMPANY_FULL_NAME": { "type": "string", "description": "| Полное наименование организации ||" }, "RQ_COMPANY_REG_DATE": { "type": "string", "description": "| Дата государственной регистрации в строковом формате, например `06.04.2007` ||" }, "RQ_DIRECTOR": { "type": "string", "description": "| Генеральный директор ||" }, "RQ_ACCOUNTANT": { "type": "string", "description": "| Главный бухгалтер ||" }, "RQ_CEO_NAME": { "type": "string", "description": "| ФИО первого руководителя ||" }, "RQ_CEO_WORK_POS": { "type": "string", "description": "| Должность первого руководителя ||" }, "RQ_CONTACT": { "type": "string", "description": "| Контактное лицо ||" }, "RQ_EMAIL": { "type": "string", "description": "| E-Mail ||" }, "RQ_PHONE": { "type": "string", "description": "| Телефон ||" }, "RQ_FAX": { "type": "string", "description": "| Факс ||" }, "RQ_IDENT_TYPE": { "type": "string", "description": "| Способ идентификации. Идентификаторы справочников для доступных стран возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "RQ_IDENT_DOC": { "type": "string", "description": "| Вид документа ||" }, "RQ_IDENT_DOC_SER": { "type": "string", "description": "| Серия ||" }, "RQ_IDENT_DOC_NUM": { "type": "string", "description": "| Номер ||" }, "RQ_IDENT_DOC_PERS_NUM": { "type": "string", "description": "| Личный номер ||" }, "RQ_IDENT_DOC_DATE": { "type": "string", "description": "| Дата выдачи в строковом формате, например `21.02.2015` ||" }, "RQ_IDENT_DOC_ISSUED_BY": { "type": "string", "description": "| Кем выдан ||" }, "RQ_IDENT_DOC_DEP_CODE": { "type": "string", "description": "| Код подразделения ||" }, "RQ_INN": { "type": "string", "description": "| ИНН ||" }, "RQ_KPP": { "type": "string", "description": "| КПП ||" }, "RQ_USRLE": { "type": "string", "description": "| Handelsregisternummer (для страны DE) ||" }, "RQ_IFNS": { "type": "string", "description": "| ИФНС ||" }, "RQ_OGRN": { "type": "string", "description": "| ОГРН ||" }, "RQ_OGRNIP": { "type": "string", "description": "| ОГРНИП ||" }, "RQ_OKPO": { "type": "string", "description": "| ОКПО ||" }, "RQ_OKTMO": { "type": "string", "description": "| ОКТМО ||" }, "RQ_OKVED": { "type": "string", "description": "| ОКВЭД ||" }, "RQ_EDRPOU": { "type": "string", "description": "| ЄДРПОУ ||" }, "RQ_DRFO": { "type": "string", "description": "| ДРФО ||" }, "RQ_KBE": { "type": "string", "description": "| КБЕ ||" }, "RQ_IIN": { "type": "string", "description": "| ИИН ||" }, "RQ_BIN": { "type": "string", "description": "| БИН ||" }, "RQ_ST_CERT_SER": { "type": "string", "description": "| Серия свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_NUM": { "type": "string", "description": "| Номер свидетельства о государственной регистрации ||" }, "RQ_ST_CERT_DATE": { "type": "string", "description": "| Дата свидетельства о государственной регистрации ||" }, "RQ_VAT_PAYER": { "type": "string", "maxLength": 1, "description": "| Платник ПДВ (для страны UA)." }, "RQ_VAT_ID": { "type": "string", "description": "| VAT ID (идентификационный номер (плательщика) НДС) ||" }, "RQ_VAT_CERT_SER": { "type": "string", "description": "| Серия свидетельства по НДС ||" }, "RQ_VAT_CERT_NUM": { "type": "string", "description": "| Номер свидетельства по НДС ||" }, "RQ_VAT_CERT_DATE": { "type": "string", "description": "| Дата свидетельства по НДС ||" }, "RQ_RESIDENCE_COUNTRY": { "type": "string", "description": "| Страна резидента ||" }, "RQ_BASE_DOC": { "type": "string", "description": "| Основание действия ||" }, "RQ_REGON": { "type": "string", "description": "| REGON (для страны PL) ||" }, "RQ_KRS": { "type": "string", "description": "| KRS (для страны PL) ||" }, "RQ_PESEL": { "type": "string", "description": "| PESEL (для страны PL) ||" }, "RQ_LEGAL_FORM": { "type": "string", "description": "| Forme juridique (для страны FR) ||" }, "RQ_SIRET": { "type": "string", "description": "| Numéro Siret (для страны FR) ||" }, "RQ_SIREN": { "type": "string", "description": "| Numéro Siren (для страны FR) ||" }, "RQ_CAPITAL": { "type": "string", "description": "| Capital social (для страны FR) ||" }, "RQ_RCS": { "type": "string", "description": "| RCS (для страны FR) ||" }, "RQ_CNPJ": { "type": "string", "description": "| CNPJ (для страны BR) ||" }, "RQ_STATE_REG": { "type": "string", "description": "| Inscrição Estadual (IE) (для страны BR) ||" }, "RQ_MNPL_REG": { "type": "string", "description": "| Inscrição Municipal (IM) (для страны BR) ||" }, "RQ_CPF": { "type": "string", "description": "| CPF (для страны BR) ||" }, "RQ_TAX_REGIME": { "type": "string", "description": "| Налоговый режим для страны MX. Идентификатор справочника возвращает метод crm.requisite.fields в атрибуте `statusType`. Чтобы получить значения справочника, передайте его идентификатор в `filter[ENTITY_ID]` метода crm.status.list ||" }, "UF_CRM_...": { "type": "string", "description": "| Пользовательские поля. Например, `UF_CRM_1694526604`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.add": { "post": { "summary": "Создать новое пользовательское поле реквизита crm.requisite.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод создает новое пользовательское поле для реквизита.", "operationId": "crm_requisite_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления пользовательского поля реквизита ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда `CRM_REQUISITE` ||" }, "FIELD_NAME": { "type": "string", "description": "| Символьный код. Для реквизитов всегда начинается с префикса `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных (`string`, `boolean`, `double` или `datetime`) ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } }, "required": [ "fields", "ENTITY_ID", "FIELD_NAME", "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}` для добавления пользовательского поля реквизита ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда `CRM_REQUISITE` ||" }, "FIELD_NAME": { "type": "string", "description": "| Символьный код. Для реквизитов всегда начинается с префикса `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных (`string`, `boolean`, `double` или `datetime`) ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } }, "required": [ "fields", "ENTITY_ID", "FIELD_NAME", "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.delete": { "post": { "summary": "Удалить пользовательское поле реквизита crm.requisite.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет пользовательское поле реквизита.", "operationId": "crm_requisite_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.get": { "post": { "summary": "Получить пользовательское поле по id crm.requisite.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает пользовательское поле реквизита по идентификатору.", "operationId": "crm_requisite_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.list": { "post": { "summary": "Получить список пользовательских полей реквизита по фильтру crm.requisite.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает список пользовательских полей реквизита по фильтру.", "operationId": "crm_requisite_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки выбранных пользовательских полей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. В фильтре этого метода поддерживается только обычное сравнение значений." }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда `CRM_REQUISITE` ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки выбранных пользовательских полей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных реквизитов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. В фильтре этого метода поддерживается только обычное сравнение значений." }, "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда `CRM_REQUISITE` ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.update": { "post": { "summary": "Изменить пользовательское поле реквизита crm.requisite.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод изменяет существующее пользовательское поле реквизита.", "operationId": "crm_requisite_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" }, "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list ||" }, "fields": { "type": "object", "description": "| Набор полей — объект вида `{\"поле\": \"значение\"[, ...]}`, значения которых нужно изменить ||" }, "XML_ID": { "type": "string", "description": "| Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы." }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Признак множественности. Возможные значения:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Признак обязательности. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Показывать ли в фильтре списка. Возможные значения:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Показывать ли в списке. Возможные значения:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Разрешать ли редактирование пользователем. Возможные значения:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Участвуют ли значения поля в поиске. Возможные значения:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Подпись в форме редактирования ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Заголовок в списке ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Подпись фильтра в списке ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Сообщение об ошибке ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Помощь ||" }, "LIST": { "type": "string", "description": "| Элементы списка. Для получения подробной информации смотрите раздел {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел {#T} ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.settings.mode.get": { "post": { "summary": "Определить текущий режим работы CRM crm.settings.mode.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте метод REST 3.0 [crm.lead.isenabled](./rest-v3/lead-mode/crm-lead-is-enabled-rest-v3.md). Он доступен только администратору CRM: если интеграция работает от имени обычного пользователя, используйте этот метод.", "operationId": "crm_settings_mode_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/crm-settings-mode-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.stagehistory.list": { "post": { "summary": "Получить историю движения по стадиям crm.stagehistory.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.stagehistory.list` возвращает записи об истории движения по стадиям для элементов:", "operationId": "crm_stagehistory_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/crm-stage-history-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Может принимать значения:" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации. Фильтр поддерживает использование точных значений, массивов значений, а также модификаторы:" }, "select": { "type": "object", "description": "| Список получаемых полей ||" }, "start": { "type": "integer", "description": "| Сдвиг для постраничной навигации. Логика работы с постраничной навигацией стандартная для списочных методов ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта. Может принимать значения:" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации. Фильтр поддерживает использование точных значений, массивов значений, а также модификаторы:" }, "select": { "type": "object", "description": "| Список получаемых полей ||" }, "start": { "type": "integer", "description": "| Сдвиг для постраничной навигации. Логика работы с постраничной навигацией стандартная для списочных методов ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.add": { "post": { "summary": "Создать элемент справочника crm.status.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.add](../rest-v3/dictionaries/crm-dictionary-add-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.add](../rest-v3/categories/crm-entity-category-stage-add-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового элемента справочника. Список доступных полей описан ниже ||" }, "ENTITY_ID": { "type": "string", "description": "| Тип справочника, например `DEAL_STAGE`, `SOURCE`. Получить список типов можно методом crm.status.entity.types ||" }, "STATUS_ID": { "type": "string", "description": "| Код значения статуса. Код должен быть уникальным в рамках справочника. Ограничения по длине и символам зависят от типа справочника||" }, "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию 10 ||" }, "COLOR": { "type": "string", "description": "| Цвет hex-код, например `#39A8EF`. Используйте для статусов-стадий ||" }, "SEMANTICS": { "type": "string", "description": "| Группа стадий:" } }, "required": [ "fields", "ENTITY_ID", "STATUS_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового элемента справочника. Список доступных полей описан ниже ||" }, "ENTITY_ID": { "type": "string", "description": "| Тип справочника, например `DEAL_STAGE`, `SOURCE`. Получить список типов можно методом crm.status.entity.types ||" }, "STATUS_ID": { "type": "string", "description": "| Код значения статуса. Код должен быть уникальным в рамках справочника. Ограничения по длине и символам зависят от типа справочника||" }, "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию 10 ||" }, "COLOR": { "type": "string", "description": "| Цвет hex-код, например `#39A8EF`. Используйте для статусов-стадий ||" }, "SEMANTICS": { "type": "string", "description": "| Группа стадий:" } }, "required": [ "fields", "ENTITY_ID", "STATUS_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.delete": { "post": { "summary": "Удалить элемент справочника crm.status.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.delete](../rest-v3/dictionaries/crm-dictionary-delete-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.delete](../rest-v3/categories/crm-entity-category-stage-delete-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника, который требуется удалить. Получить список идентификаторов можно методом crm.status.list ||" }, "params": { "type": "string", "description": "| Доступные флаги:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника, который требуется удалить. Получить список идентификаторов можно методом crm.status.list ||" }, "params": { "type": "string", "description": "| Доступные флаги:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.entity.items": { "post": { "summary": "Получить элементы справочника по типу crm.status.entity.items", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.list](../rest-v3/dictionaries/crm-dictionary-list-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.list](../rest-v3/categories/crm-entity-category-stage-list-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_entity_items", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-items.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "| Тип справочника, например `DEAL_STAGE`, `SOURCE`. Получить список типов можно методом crm.status.entity.types ||" } }, "required": [ "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "| Тип справочника, например `DEAL_STAGE`, `SOURCE`. Получить список типов можно методом crm.status.entity.types ||" } }, "required": [ "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.entity.types": { "post": { "summary": "Получить типы справочников crm.status.entity.types", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.status.entity.types` возвращает список всех поддерживаемых типов справочников, объектов `ENTITY_ID`.", "operationId": "crm_status_entity_types", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.fields": { "post": { "summary": "Получить описание полей справочника crm.status.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 `crm.dictionary.<справочник>.field.list` из группы [Справочники](../rest-v3/dictionaries/index.md), для стадий — `crm.<тип>.category.stage.field.list` из группы [Воронки и стадии](../rest-v3/categories/index.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.get": { "post": { "summary": "Получить элемент справочника по идентификатору crm.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.get](../rest-v3/dictionaries/crm-dictionary-get-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.get](../rest-v3/categories/crm-entity-category-stage-get-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника. Получить список элементов с идентификаторами можно методом crm.status.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника. Получить список элементов с идентификаторами можно методом crm.status.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.list": { "post": { "summary": "Получить список элементов справочника по фильтру crm.status.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.list](../rest-v3/dictionaries/crm-dictionary-list-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.list](../rest-v3/categories/crm-entity-category-stage-list-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.update": { "post": { "summary": "Обновить элемент справочника crm.status.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для справочников используйте метод REST 3.0 [crm.dictionary.<справочник>.update](../rest-v3/dictionaries/crm-dictionary-update-rest-v3.md), для стадий сделок и смарт-процессов — [crm.<тип>.category.stage.update](../rest-v3/categories/crm-entity-category-stage-update-rest-v3.md). Стадий лидов, предложений и счетов и справочника статусов списков обзвона в REST 3.0 нет, для них используйте этот метод.", "operationId": "crm_status_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника, который нужно обновить. Получить список можно методом crm.status.list ||" }, "fields": { "type": "object", "description": "| Массив полей для обновления. Список доступных полей описан ниже ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "COLOR": { "type": "string", "description": "| Цвет hex-код, например `#39A8EF` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор элемента справочника, который нужно обновить. Получить список можно методом crm.status.list ||" }, "fields": { "type": "object", "description": "| Массив полей для обновления. Список доступных полей описан ниже ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "COLOR": { "type": "string", "description": "| Цвет hex-код, например `#39A8EF` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.bind": { "post": { "summary": "Добавить связь записи таймлайна с элементом CRM crm.timeline.bindings.bind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.bindings.bind` добавляет связь записи таймлайна с элементом CRM. После этого запись показывается в таймлайне указанного элемента.", "operationId": "crm_timeline_bindings_bind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления связи записи таймлайна с элементом CRM в виде структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор элемента CRM, с которым связывается запись таймлайна ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Символьный код типа объекта CRM `entityTypeName`, с которым связывается запись таймлайна. Регистр значения не важен. Возможные значения:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления связи записи таймлайна с элементом CRM в виде структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор элемента CRM, с которым связывается запись таймлайна ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Символьный код типа объекта CRM `entityTypeName`, с которым связывается запись таймлайна. Регистр значения не важен. Возможные значения:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.fields": { "post": { "summary": "Получить поля связи записи таймлайна с элементом CRM crm.timeline.bindings.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.bindings.fields` получает описание полей связи записи таймлайна с элементом CRM.", "operationId": "crm_timeline_bindings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.list": { "post": { "summary": "Получить список связей записи таймлайна с элементами CRM crm.timeline.bindings.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.bindings.list` получает список связей одной записи таймлайна с элементами CRM.", "operationId": "crm_timeline_bindings_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей (подробное описание) ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "order": { "type": "object", "description": "| Метод принимает параметр, но не учитывает его: сортировка результата не поддерживается." }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна, связи которой нужно получить. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list." } }, "required": [ "filter", "OWNER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей (подробное описание) ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "order": { "type": "object", "description": "| Метод принимает параметр, но не учитывает его: сортировка результата не поддерживается." }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна, связи которой нужно получить. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list." } }, "required": [ "filter", "OWNER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.unbind": { "post": { "summary": "Удалить связь записи таймлайна с элементом CRM crm.timeline.bindings.unbind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.bindings.unbind` удаляет связь записи таймлайна с элементом CRM. После этого запись перестает показываться в таймлайне указанного элемента, но сама она не удаляется.", "operationId": "crm_timeline_bindings_unbind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для удаления связи записи таймлайна с элементом CRM в виде структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор элемента CRM, с которым связана запись таймлайна ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Символьный код типа объекта CRM `entityTypeName`, с которым связана запись таймлайна. Регистр значения не важен. Возможные значения:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для удаления связи записи таймлайна с элементом CRM в виде структуры:" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list ||" }, "ENTITY_ID": { "type": "integer", "description": "| Идентификатор элемента CRM, с которым связана запись таймлайна ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Символьный код типа объекта CRM `entityTypeName`, с которым связана запись таймлайна. Регистр значения не важен. Возможные значения:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.add": { "post": { "summary": "Добавить комментарий crm.timeline.comment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет новое дело типа «Комментарий» в таймлайн.", "operationId": "crm_timeline_comment_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления нового дела типа «Комментарий» в виде структуры:" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` элемента, к которому привязан комментарий." }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор системного или пользовательского типа объекта CRM, к элементу которого привязан комментарий. Например: `lead`, `deal`, `contact`, `company`, `order`, `dynamic_1046` ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } }, "required": [ "fields", "ENTITY_ID", "ENTITY_TYPE", "COMMENT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления нового дела типа «Комментарий» в виде структуры:" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` элемента, к которому привязан комментарий." }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор системного или пользовательского типа объекта CRM, к элементу которого привязан комментарий. Например: `lead`, `deal`, `contact`, `company`, `order`, `dynamic_1046` ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } }, "required": [ "fields", "ENTITY_ID", "ENTITY_TYPE", "COMMENT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.delete": { "post": { "summary": "Удалить комментарий crm.timeline.comment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет дело типа «Комментарий».", "operationId": "crm_timeline_comment_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" }, "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому привязан комментарий (например, `2` для сделки) ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому привязан комментарий (например, `1`). Получить список идентификаторов можно с помощью метода `crm.timeline.bindings.list` (поле `ENTITY_ID`) ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" }, "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому привязан комментарий (например, `2` для сделки) ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому привязан комментарий (например, `1`). Получить список идентификаторов можно с помощью метода `crm.timeline.bindings.list` (поле `ENTITY_ID`) ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.fields": { "post": { "summary": "Получить поля комментария crm.timeline.comment.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает поля дела типа «Комментарий».", "operationId": "crm_timeline_comment_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Корневой элемент ответа, содержащий все поля комментария ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор. Только для чтения ||" }, "CREATED": { "type": "string", "format": "date-time", "description": "| Дата добавления. Только для чтения ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` элемента, к которому привязан комментарий. Неизменяемое ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип элемента, к которому привязан комментарий. Неизменяемое." }, "AUTHOR_ID": { "type": "integer", "description": "| Автор. Неизменяемое ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Корневой элемент ответа, содержащий все поля комментария ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор. Только для чтения ||" }, "CREATED": { "type": "string", "format": "date-time", "description": "| Дата добавления. Только для чтения ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` элемента, к которому привязан комментарий. Неизменяемое ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип элемента, к которому привязан комментарий. Неизменяемое." }, "AUTHOR_ID": { "type": "integer", "description": "| Автор. Неизменяемое ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.get": { "post": { "summary": "Получить информацию о комментарии crm.timeline.comment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает информацию о деле типа «Комментарий».", "operationId": "crm_timeline_comment_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.list": { "post": { "summary": "Получить список комментариев crm.timeline.comment.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.comment.list` получает список всех дел типа «Комментарий» указанного элемента CRM.", "operationId": "crm_timeline_comment_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые необходимо выбрать. Передавайте поля объекта result. Если не передан или передан пустой массив, будут возвращены все поля ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных комментариев в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных комментариев в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые необходимо выбрать. Передавайте поля объекта result. Если не передан или передан пустой массив, будут возвращены все поля ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных комментариев в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных комментариев в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.update": { "post": { "summary": "Обновить комментарий crm.timeline.comment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет дело типа «Комментарий» в таймлайне.", "operationId": "crm_timeline_comment_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления дела типа «Комментарий» в виде структуры:" }, "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому привязан комментарий (например, `2` для сделки) ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому привязан комментарий (например, `1`). Получить список идентификаторов можно методом `crm.timeline.bindings.list` (поле `ENTITY_ID`) ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор дела типа «Комментарий» (например, `1`). Получить идентификаторы можно методом `crm.timeline.comment.list` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления дела типа «Комментарий» в виде структуры:" }, "ownerTypeId": { "type": "integer", "description": "| Целочисленный идентификатор типа объекта CRM, к которому привязан комментарий (например, `2` для сделки) ||" }, "ownerId": { "type": "integer", "description": "| Целочисленный идентификатор элемента CRM, к которому привязан комментарий (например, `1`). Получить список идентификаторов можно методом `crm.timeline.bindings.list` (поле `ENTITY_ID`) ||" }, "COMMENT": { "type": "string", "description": "| Текст комментария ||" }, "FILES": { "type": "string", "description": "| Список файлов. Массив значений, описанный по правилам ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.add": { "post": { "summary": "Добавить иконку crm.timeline.icon.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.icon.add` добавляет новую иконку.", "operationId": "crm_timeline_icon_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код иконки (например, `custom-info`). Код не должен совпадать с кодом системной иконки ||" }, "fileContent": { "type": "string", "description": "| Закодированное `base64` содержимое файла иконки." } }, "required": [ "code", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код иконки (например, `custom-info`). Код не должен совпадать с кодом системной иконки ||" }, "fileContent": { "type": "string", "description": "| Закодированное `base64` содержимое файла иконки." } }, "required": [ "code", "fileContent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.delete": { "post": { "summary": "Удалить иконку crm.timeline.icon.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.icon.delete` удаляет пользовательскую иконку и ее файл. Системные иконки удалить нельзя: для системного кода метод вернет ошибку `NOT_FOUND`.", "operationId": "crm_timeline_icon_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код пользовательской иконки (например, `custom-info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код пользовательской иконки (например, `custom-info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.get": { "post": { "summary": "Получить информацию об иконке crm.timeline.icon.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.icon.get` получает информацию об иконке лог-записи таймлайна.", "operationId": "crm_timeline_icon_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код иконки (например, `custom-info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код иконки (например, `custom-info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.list": { "post": { "summary": "Получить список доступных иконок crm.timeline.icon.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.icon.list` получает полный список системных и пользовательских иконок лог-записей таймлайна.", "operationId": "crm_timeline_icon_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.item.pin": { "post": { "summary": "Закрепить запись в таймлайне crm.timeline.item.pin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.item.pin` закрепляет запись в таймлайне.", "operationId": "crm_timeline_item_pin", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/actions/crm-timeline-item-pin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи таймлайна, например `999`. Получить id можно методом crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязана запись, например `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи таймлайна, например `999`. Получить id можно методом crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязана запись, например `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.item.unpin": { "post": { "summary": "Открепить запись в таймлайне crm.timeline.item.unpin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.item.unpin` открепляет запись в таймлайне.", "operationId": "crm_timeline_item_unpin", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/actions/crm-timeline-item-unpin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи таймлайна, например `999`. Получить id можно методом crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязана запись, например `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи таймлайна, например `999`. Получить id можно методом crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись, например `2` для сделки ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязана запись, например `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.delete": { "post": { "summary": "Удалить набор дополнительных контентных блоков для записи таймлайна crm.timeline.layout.blocks.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.layout.blocks.delete` удаляет набор дополнительных контентных блоков для записи таймлайна.", "operationId": "crm_timeline_layout_blocks_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.get": { "post": { "summary": "Получить набор дополнительных контентных блоков для записи таймлайна crm.timeline.layout.blocks.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.layout.blocks.get` получает набор дополнительных контентных блоков для записи таймлайна.", "operationId": "crm_timeline_layout_blocks_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.set": { "post": { "summary": "Установить набор дополнительных контентных блоков в запись таймлайна crm.timeline.layout.blocks.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.layout.blocks.set` устанавливает набор дополнительных контентных блоков для записи таймлайна.", "operationId": "crm_timeline_layout_blocks_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" }, "layout": { "type": "string", "description": "| Объект, описывающий набор дополнительных контентных блоков ||" } }, "required": [ "entityTypeId", "entityId", "timelineId", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта CRM, к которому привязана запись таймлайна ||" }, "timelineId": { "type": "integer", "description": "| Идентификатор записи таймлайна ||" }, "layout": { "type": "string", "description": "| Объект, описывающий набор дополнительных контентных блоков ||" } }, "required": [ "entityTypeId", "entityId", "timelineId", "layout" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.add": { "post": { "summary": "Добавить лог-запись crm.timeline.logmessage.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет новую лог-запись таймлайна.", "operationId": "crm_timeline_logmessage_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой лог-записи в виде структуры:" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа сущности, в которой будет создана запись ||" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента сущности, в которой будет создана запись ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "text": { "type": "string", "description": "| Текст записи ||" }, "iconCode": { "type": "string", "description": "| Код иконки." } }, "required": [ "fields", "entityTypeId", "entityId", "title", "text", "iconCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления новой лог-записи в виде структуры:" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор типа сущности, в которой будет создана запись ||" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента сущности, в которой будет создана запись ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "text": { "type": "string", "description": "| Текст записи ||" }, "iconCode": { "type": "string", "description": "| Код иконки." } }, "required": [ "fields", "entityTypeId", "entityId", "title", "text", "iconCode" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.delete": { "post": { "summary": "Удалить лог-запись crm.timeline.logmessage.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет лог-запись таймлайна.", "operationId": "crm_timeline_logmessage_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор записи таймлайна (например, `1`)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор записи таймлайна (например, `1`)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.get": { "post": { "summary": "Получить информацию о лог-записи crm.timeline.logmessage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает информацию о лог-записи таймлайна.", "operationId": "crm_timeline_logmessage_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор записи таймлайна (например, `1`)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Целочисленный идентификатор записи таймлайна (например, `1`)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.list": { "post": { "summary": "Получить список лог-записей таймлайна crm.timeline.logmessage.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает список лог-записей таймлайна.", "operationId": "crm_timeline_logmessage_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа сущности, для которой нужно получить список лог-записей (например, `1` — лид) ||" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента сущности, для которого нужно получить список лог-записей (например, `1`) ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `asc` или `desc`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа сущности, для которой нужно получить список лог-записей (например, `1` — лид) ||" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента сущности, для которого нужно получить список лог-записей (например, `1`) ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `asc` или `desc`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.add": { "post": { "summary": "Добавить логотип crm.timeline.logo.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.logo.add` добавляет новый пользовательский логотип. Его код можно передать в поле [`layout.body.logo.code`](../../activities/configurable/structure/body.md#logo-dto) при создании или изменении конфигурируемого дела.", "operationId": "crm_timeline_logo_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код пользовательского логотипа, например `info`. Код не должен совпадать с кодом существующего пользовательского или системного логотипа ||" }, "fileContent": { "type": "string", "description": "| Закодированное `base64` содержимое файла логотипа." } }, "required": [ "code", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код пользовательского логотипа, например `info`. Код не должен совпадать с кодом существующего пользовательского или системного логотипа ||" }, "fileContent": { "type": "string", "description": "| Закодированное `base64` содержимое файла логотипа." } }, "required": [ "code", "fileContent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.delete": { "post": { "summary": "Удалить логотип crm.timeline.logo.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.logo.delete` удаляет пользовательский логотип. Системный логотип удалить нельзя: метод вернет ошибку `NOT_FOUND`.", "operationId": "crm_timeline_logo_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код логотипа (например, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код логотипа (например, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.get": { "post": { "summary": "Получить информацию о логотипе crm.timeline.logo.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.logo.get` получает информацию о системном или пользовательском логотипе по коду. Код логотипа используется в поле [`layout.body.logo.code`](../../activities/configurable/structure/body.md#logo-dto) конфигурируемого дела.", "operationId": "crm_timeline_logo_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код логотипа (например, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код логотипа (например, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.list": { "post": { "summary": "Получить список доступных логотипов crm.timeline.logo.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.timeline.logo.list` получает полный список доступных логотипов таймлайна: системных и пользовательских. Выбранный код можно передать в поле [`layout.body.logo.code`](../../activities/configurable/structure/body.md#logo-dto) конфигурируемого дела.", "operationId": "crm_timeline_logo_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.delete": { "post": { "summary": "Удалить заметку crm.timeline.note.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет заметку таймлайна.", "operationId": "crm_timeline_note_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.get": { "post": { "summary": "Получить информацию о заметке crm.timeline.note.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает информацию о заметке к записи таймлайна.", "operationId": "crm_timeline_note_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.save": { "post": { "summary": "Сохранить заметку crm.timeline.note.save", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод позволяет сохранить заметку.", "operationId": "crm_timeline_note_save", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-save.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" }, "text": { "type": "string", "description": "| Текст заметки ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Идентификатор типа элемента, к которому относится запись ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента, к которому относится запись ||" }, "itemType": { "type": "integer", "description": "| Тип записи, к которой нужно применить заметку:" }, "itemId": { "type": "integer", "description": "| Идентификатор записи, к которой нужно применить заметку. Если `itemType=1`, то это идентификатор записи истории таймлайна. Если `itemType=2`, то это идентификатор дела ||" }, "text": { "type": "string", "description": "| Текст заметки ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId", "text" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.tracking.trace.add": { "post": { "summary": "Создать трейс сквозной аналитики crm.tracking.trace.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.tracking.trace.add` создает трейс сквозной аналитики и возвращает его идентификатор.", "operationId": "crm_tracking_trace_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/tracking/crm-tracking-trace-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITIES": { "type": "string", "description": "| Массив объектов, которые нужно связать с трейсом (подробное описание)" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITIES": { "type": "string", "description": "| Массив объектов, которые нужно связать с трейсом (подробное описание)" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.tracking.trace.delete": { "post": { "summary": "Удалить трейс сквозной аналитики crm.tracking.trace.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.tracking.trace.delete` удаляет трейс сквозной аналитики.", "operationId": "crm_tracking_trace_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/tracking/crm-tracking-trace-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.add": { "post": { "summary": "Создать новый пользовательский тип crm.type.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод создает новый смарт-процесс.", "operationId": "crm_type_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления нового смарт-процесса ||" }, "title": { "type": "string", "description": "| Название смарт-процесса | ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор создаваемого смарт-процесса. Если не передавать данное поле, то оно будет сгенерировано автоматически." }, "relations": { "type": "object", "description": "| Объект, содержащий в себе связи к другим сущностям CRM. Структура описана ниже | ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Включено ли использование смарт-процесса в пользовательском поле | `N` ||" }, "linkedUserFields": { "type": "object", "description": "| Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана ниже | `{}` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Включены ли роботы и триггеры | `N` ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Включены ли поля Дата начала и Дата завершения | `N` ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Включено ли использование дизайнера бизнес процессов | `N` ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Включены ли свои воронки и туннели продаж | `N` ||" }, "isClientEnabled": { "type": "boolean", "description": "| Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и Компаниям | `N` ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Включена ли печать документов | `N` ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Включена ли привязка товаров каталога | `N` ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Включено ли поле Реквизиты вашей компании | `N` ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Включено ли поле Наблюдатели | `N` ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Включено ли использование корзины | `N` ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Делать ли новые воронки доступными для всех | `Y` ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Включены ли поля Источник и Дополнительно об источнике | `N` ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Включено ли использование своих стадий и канбана | `N` ||" }, "isExternal": { "type": "boolean", "description": "| Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту)" }, "customSectionId": { "type": "integer", "description": "| Идентификатор цифрового рабочего места" }, "customSections": { "type": "array", "items": {}, "description": "| Массив цифровых рабочих мест" }, "parent": { "type": "string", "description": "| Элементы CRM, которые будут привязаны к данному смарт-процессу ||" }, "child": { "type": "string", "description": "| Элементы CRM, к котором будет привязан данный смарт-процесс ||" }, "isChildrenListEnabled": { "type": "boolean", "description": "| Добавлять ли связанный элемент в карточку." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления нового смарт-процесса ||" }, "title": { "type": "string", "description": "| Название смарт-процесса | ||" }, "entityTypeId": { "type": "integer", "description": "| Идентификатор создаваемого смарт-процесса. Если не передавать данное поле, то оно будет сгенерировано автоматически." }, "relations": { "type": "object", "description": "| Объект, содержащий в себе связи к другим сущностям CRM. Структура описана ниже | ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Включено ли использование смарт-процесса в пользовательском поле | `N` ||" }, "linkedUserFields": { "type": "object", "description": "| Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана ниже | `{}` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Включены ли роботы и триггеры | `N` ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Включены ли поля Дата начала и Дата завершения | `N` ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Включено ли использование дизайнера бизнес процессов | `N` ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Включены ли свои воронки и туннели продаж | `N` ||" }, "isClientEnabled": { "type": "boolean", "description": "| Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и Компаниям | `N` ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Включена ли печать документов | `N` ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Включена ли привязка товаров каталога | `N` ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Включено ли поле Реквизиты вашей компании | `N` ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Включено ли поле Наблюдатели | `N` ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Включено ли использование корзины | `N` ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Делать ли новые воронки доступными для всех | `Y` ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Включены ли поля Источник и Дополнительно об источнике | `N` ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Включено ли использование своих стадий и канбана | `N` ||" }, "isExternal": { "type": "boolean", "description": "| Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту)" }, "customSectionId": { "type": "integer", "description": "| Идентификатор цифрового рабочего места" }, "customSections": { "type": "array", "items": {}, "description": "| Массив цифровых рабочих мест" }, "parent": { "type": "string", "description": "| Элементы CRM, которые будут привязаны к данному смарт-процессу ||" }, "child": { "type": "string", "description": "| Элементы CRM, к котором будет привязан данный смарт-процесс ||" }, "isChildrenListEnabled": { "type": "boolean", "description": "| Добавлять ли связанный элемент в карточку." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.delete": { "post": { "summary": "Удалить пользовательский тип crm.type.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет существующий смарт-процесс по идентификатору `id`.", "operationId": "crm_type_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.fields": { "post": { "summary": "Получить поля пользовательского типа crm.type.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает информацию о собственных полях настроек смарт-процесса.", "operationId": "crm_type_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Корневой элемент ответа. Содержит объект с единственным ключом `fields` ||" }, "fields": { "type": "object", "description": "| Объект в формате: `{ field_1: value_1, field_2: value_2, ... , field_n: value_n }`, где `field_n` — поля настроек смарт-процесса, а `value_n` — объект типа `crm_rest_field_description` ||" }, "time": { "type": "string", "description": "| Объект, содержащий в себе информацию о времени выполнения запроса ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Корневой элемент ответа. Содержит объект с единственным ключом `fields` ||" }, "fields": { "type": "object", "description": "| Объект в формате: `{ field_1: value_1, field_2: value_2, ... , field_n: value_n }`, где `field_n` — поля настроек смарт-процесса, а `value_n` — объект типа `crm_rest_field_description` ||" }, "time": { "type": "string", "description": "| Объект, содержащий в себе информацию о времени выполнения запроса ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.get": { "post": { "summary": "Получить пользовательский тип по id crm.type.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает информацию о смарт-процессе с идентификатором `id`.", "operationId": "crm_type_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.getByEntityTypeId": { "post": { "summary": "Получить пользовательский тип по entityTypeId crm.type.getByEntityTypeId", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает информацию о смарт-процессе с идентификатором типа смарт-процесса `entityTypeId`.", "operationId": "crm_type_getByEntityTypeId", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа смарт-процесса. ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Идентификатор типа смарт-процесса. ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.list": { "post": { "summary": "Получить список пользовательских типов crm.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает список настроек смарт-процессов.", "operationId": "crm_type_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, где" }, "filter": { "type": "object", "description": "| Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, где" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, где" }, "filter": { "type": "object", "description": "| Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, где" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.update": { "post": { "summary": "Обновить пользовательский тип crm.type.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет существующий смарт-процесс по его идентификатору `id`.", "operationId": "crm_type_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-object-types/crm-type-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления смарт-процесса ||" }, "title": { "type": "string", "description": "| Название смарт-процесса ||" }, "relations": { "type": "object", "description": "| Объект, содержащий в себе связи к другим сущностям CRM. Структура описана объектом `type.relations` ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Включено ли использование смарт-процесса в пользовательском поле ||" }, "linkedUserFields": { "type": "object", "description": "| Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана объектом `type.linkedUserFields` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Включены ли роботы и триггеры ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Включены ли поля Дата начала и Дата завершения ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Включено ли использование дизайнера бизнес процессов ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Включены ли свои воронки и туннели продаж ||" }, "isClientEnabled": { "type": "boolean", "description": "| Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и Компаниям ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Включена ли печать документов ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Включена ли привязка товаров каталога ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Включено ли поле Реквизиты вашей компании ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Включено ли поле Наблюдатели ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Включено ли использование корзины ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Делать ли новые воронки доступными для всех ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Включены ли поля Источник и Дополнительно об источнике ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Включено ли использование своих стадий и канбана ||" }, "isExternal": { "type": "boolean", "description": "| Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту)" }, "customSectionId": { "type": "integer", "description": "| Идентификатор цифрового рабочего места" }, "customSections": { "type": "array", "items": {}, "description": "| Массив цифровых рабочих мест" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор смарт-процесса. Можно получить с помощью методов: `crm.type.list`, `crm.type.add` ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления смарт-процесса ||" }, "title": { "type": "string", "description": "| Название смарт-процесса ||" }, "relations": { "type": "object", "description": "| Объект, содержащий в себе связи к другим сущностям CRM. Структура описана объектом `type.relations` ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Включено ли использование смарт-процесса в пользовательском поле ||" }, "linkedUserFields": { "type": "object", "description": "| Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана объектом `type.linkedUserFields` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Включены ли роботы и триггеры ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Включены ли поля Дата начала и Дата завершения ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Включено ли использование дизайнера бизнес процессов ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Включены ли свои воронки и туннели продаж ||" }, "isClientEnabled": { "type": "boolean", "description": "| Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и Компаниям ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Включена ли печать документов ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Включена ли привязка товаров каталога ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Включено ли поле Реквизиты вашей компании ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Включено ли поле Наблюдатели ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Включено ли использование корзины ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Делать ли новые воронки доступными для всех ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Включены ли поля Источник и Дополнительно об источнике ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Включено ли использование своих стадий и канбана ||" }, "isExternal": { "type": "boolean", "description": "| Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту)" }, "customSectionId": { "type": "integer", "description": "| Идентификатор цифрового рабочего места" }, "customSections": { "type": "array", "items": {}, "description": "| Массив цифровых рабочих мест" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.enumeration.fields": { "post": { "summary": "Получить описание полей для пользовательского поля типа «enumeration» (список) crm.userfield.enumeration.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.userfield.enumeration.fields` возвращает описание полей для пользовательского поля типа \"enumeration\" (список).", "operationId": "crm_userfield_enumeration_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-fields/crm-userfield-enumeration-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.fields": { "post": { "summary": "Получить описание для пользовательских полей crm.userfield.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.userfield.fields` возвращает описание характеристик пользовательских полей", "operationId": "crm_userfield_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-fields/crm-userfield-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.settings.fields": { "post": { "summary": "Получить описание полей настроек для типа пользовательского поля crm.userfield.settings.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.userfield.settings.fields` возвращает описание полей настроек для указанного типа пользовательского поля.", "operationId": "crm_userfield_settings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-fields/crm-userfield-settings-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип пользовательского поля. Значение из списка, который возвращает метод crm.userfield.types ||" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип пользовательского поля. Значение из списка, который возвращает метод crm.userfield.types ||" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.types": { "post": { "summary": "Получить список типов пользовательских полей crm.userfield.types", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `crm.userfield.types` получает доступные типы пользовательских полей.", "operationId": "crm_userfield_types", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/user-defined-fields/crm-userfield-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.add": { "post": { "summary": "Создать ставку НДС crm.vat.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.add](../../../catalog/vat/catalog-vat-add.md).", "operationId": "crm_vat_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "ACTIVE": { "type": "string", "description": "| Активность ставки:" }, "C_SORT": { "type": "integer", "description": "| Сортировка." }, "RATE": { "type": "number", "format": "double", "description": "| Значение ставки НДС, % ||" } }, "required": [ "fields", "RATE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект формата:" }, "ACTIVE": { "type": "string", "description": "| Активность ставки:" }, "C_SORT": { "type": "integer", "description": "| Сортировка." }, "RATE": { "type": "number", "format": "double", "description": "| Значение ставки НДС, % ||" } }, "required": [ "fields", "RATE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.delete": { "post": { "summary": "Удалить ставку НДС crm.vat.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.delete](../../../catalog/vat/catalog-vat-delete.md).", "operationId": "crm_vat_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую требуется удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую требуется удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.fields": { "post": { "summary": "Получить поля ставки НДС crm.vat.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.getFields](../../../catalog/vat/catalog-vat-get-fields.md).", "operationId": "crm_vat_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.get": { "post": { "summary": "Получить ставку НДС по идентификатору crm.vat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.get](../../../catalog/vat/catalog-vat-get.md).", "operationId": "crm_vat_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС. Получить список ставок можно методом crm.vat.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС. Получить список ставок можно методом crm.vat.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.list": { "post": { "summary": "Получить список ставок НДС по фильтру crm.vat.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.list](../../../catalog/vat/catalog-vat-list.md).", "operationId": "crm_vat_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "array", "items": {}, "description": "| Массив возвращаемых полей. Если не указан, возвращаются все поля ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "array", "items": {}, "description": "| Массив возвращаемых полей. Если не указан, возвращаются все поля ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.update": { "post": { "summary": "Обновить существующую ставку НДС crm.vat.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [catalog.vat.update](../../../catalog/vat/catalog-vat-update.md).", "operationId": "crm_vat_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/outdated/vat/crm-vat-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую нужно обновить. Получить список ставок можно методом crm.vat.list ||" }, "fields": { "type": "object", "description": "| Массив полей для обновления. Список доступных полей описан ниже ||" }, "ACTIVE": { "type": "string", "description": "| Активность ставки:" }, "C_SORT": { "type": "integer", "description": "| Сортировка||" }, "RATE": { "type": "number", "format": "double", "description": "| Значение ставки НДС, % ||" } }, "required": [ "id", "fields", "RATE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор ставки НДС, которую нужно обновить. Получить список ставок можно методом crm.vat.list ||" }, "fields": { "type": "object", "description": "| Массив полей для обновления. Список доступных полей описан ниже ||" }, "ACTIVE": { "type": "string", "description": "| Активность ставки:" }, "C_SORT": { "type": "integer", "description": "| Сортировка||" }, "RATE": { "type": "number", "format": "double", "description": "| Значение ставки НДС, % ||" } }, "required": [ "id", "fields", "RATE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/department.add": { "post": { "summary": "Создать подразделение department.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `department.add` создает подразделение в структуре компании и возвращает его идентификатор. Новое подразделение входит в родительское, которое указано в `PARENT`.", "operationId": "department_add", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/department-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "integer", "description": "| Поле сортировки подразделения ||" }, "PARENT": { "type": "integer", "description": "| Идентификатор родительского подразделения." }, "UF_HEAD": { "type": "integer", "description": "| Идентификатор пользователя, который станет руководителем подразделения. Метод не проверяет, есть ли такой пользователь в Битрикс24: с несуществующим идентификатором подразделение создастся без ошибки, и этот идентификатор сохранится в `UF_HEAD`." } }, "required": [ "PARENT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "integer", "description": "| Поле сортировки подразделения ||" }, "PARENT": { "type": "integer", "description": "| Идентификатор родительского подразделения." }, "UF_HEAD": { "type": "integer", "description": "| Идентификатор пользователя, который станет руководителем подразделения. Метод не проверяет, есть ли такой пользователь в Битрикс24: с несуществующим идентификатором подразделение создастся без ошибки, и этот идентификатор сохранится в `UF_HEAD`." } }, "required": [ "PARENT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.delete": { "post": { "summary": "Удалить подразделение department.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `department.delete` удаляет подразделение из структуры компании. Дочерние подразделения остаются и переходят в подразделение уровнем выше.", "operationId": "department_delete", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/department-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор подразделения." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор подразделения." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.fields": { "post": { "summary": "Получить список названий полей подразделения department.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `department.fields` возвращает названия полей подразделения.", "operationId": "department_fields", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/department-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.get": { "post": { "summary": "Получить список подразделений department.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `department.get` возвращает список активных подразделений структуры компании, например все подразделения внутри одного родительского. Имена фильтров `ID`, `NAME`, `SORT`, `PARENT` и `UF_HEAD` пишите в верхнем регистре: фильтр в другом регистре метод игнорирует.", "operationId": "department_get", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/department-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "type": "string", "description": "| Название поля, по которому нужна сортировка. Сортировка работает по полям:" }, "order": { "type": "string", "description": "| Направление сортировки, по умолчанию — `ASC`:" }, "ID": { "type": "integer", "description": "| Фильтр по идентификатору подразделения ||" }, "SORT": { "type": "integer", "description": "| Фильтр по полю сортировки. Метод принимает параметр, но не применяет: в ответ попадают подразделения с любым значением `SORT` ||" }, "PARENT": { "type": "integer", "description": "| Фильтр по идентификатору родительского подразделения. Чтобы получить подразделение верхнего уровня, передайте `0` ||" }, "UF_HEAD": { "type": "integer", "description": "| Фильтр по идентификатору руководителя подразделения ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sort": { "type": "string", "description": "| Название поля, по которому нужна сортировка. Сортировка работает по полям:" }, "order": { "type": "string", "description": "| Направление сортировки, по умолчанию — `ASC`:" }, "ID": { "type": "integer", "description": "| Фильтр по идентификатору подразделения ||" }, "SORT": { "type": "integer", "description": "| Фильтр по полю сортировки. Метод принимает параметр, но не применяет: в ответ попадают подразделения с любым значением `SORT` ||" }, "PARENT": { "type": "integer", "description": "| Фильтр по идентификатору родительского подразделения. Чтобы получить подразделение верхнего уровня, передайте `0` ||" }, "UF_HEAD": { "type": "integer", "description": "| Фильтр по идентификатору руководителя подразделения ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.update": { "post": { "summary": "Изменить подразделение department.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `department.update` изменяет подразделение в структуре компании. Поля, которые не переданы, остаются прежними.", "operationId": "department_update", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/department-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор подразделения." }, "SORT": { "type": "integer", "description": "| Поле сортировки подразделения ||" }, "PARENT": { "type": "integer", "description": "| Идентификатор родительского подразделения." }, "UF_HEAD": { "type": "integer", "description": "| Идентификатор пользователя, который будет руководителем подразделения. Чтобы снять руководителя, передайте `0`." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор подразделения." }, "SORT": { "type": "integer", "description": "| Поле сортировки подразделения ||" }, "PARENT": { "type": "integer", "description": "| Идентификатор родительского подразделения." }, "UF_HEAD": { "type": "integer", "description": "| Идентификатор пользователя, который будет руководителем подразделения. Чтобы снять руководителя, передайте `0`." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/detailpagelayout.add": { "post": { "summary": "Создать дополнительный вид карточки v 3.0 crm.<тип>.detailpagelayout.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "fields": { "type": "object", "description": "| Поля нового вида (подробное описание) ||" }, "configuration": { "type": "string", "description": "| Разделы карточки в порядке вывода, хотя бы один раздел (подробное описание) ||" }, "audience": { "type": "string", "description": "| Участники, которым доступен вид, хотя бы один (подробное описание). Пользователя, который создает вид, метод добавляет в аудиторию сам ||" }, "title": { "type": "string", "description": "| Заголовок раздела в карточке ||" }, "elements": { "type": "string", "description": "| Поля раздела в порядке вывода (подробное описание). Можно передать пустой массив ||" }, "optionFlags": { "type": "integer", "description": "| Показывать ли поле, когда оно не заполнено." }, "options": { "type": "object", "description": "| Настройки поля в формате `{\"настройка\": \"значение\"}`, например `{\"defaultCountry\": \"RU\"}` для телефона. Набор настроек зависит от поля. Настройки полей есть в конфигурации вида, которую возвращает метод crm.<тип>.detailpagelayout.get ||" }, "type": { "type": "string", "description": "| Тип участника." }, "id": { "type": "integer", "description": "| Идентификатор участника, положительное число ||" } }, "required": [ "categoryId", "fields", "configuration", "audience", "title", "elements", "type", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "fields": { "type": "object", "description": "| Поля нового вида (подробное описание) ||" }, "configuration": { "type": "string", "description": "| Разделы карточки в порядке вывода, хотя бы один раздел (подробное описание) ||" }, "audience": { "type": "string", "description": "| Участники, которым доступен вид, хотя бы один (подробное описание). Пользователя, который создает вид, метод добавляет в аудиторию сам ||" }, "title": { "type": "string", "description": "| Заголовок раздела в карточке ||" }, "elements": { "type": "string", "description": "| Поля раздела в порядке вывода (подробное описание). Можно передать пустой массив ||" }, "optionFlags": { "type": "integer", "description": "| Показывать ли поле, когда оно не заполнено." }, "options": { "type": "object", "description": "| Настройки поля в формате `{\"настройка\": \"значение\"}`, например `{\"defaultCountry\": \"RU\"}` для телефона. Набор настроек зависит от поля. Настройки полей есть в конфигурации вида, которую возвращает метод crm.<тип>.detailpagelayout.get ||" }, "type": { "type": "string", "description": "| Тип участника." }, "id": { "type": "integer", "description": "| Идентификатор участника, положительное число ||" } }, "required": [ "categoryId", "fields", "configuration", "audience", "title", "elements", "type", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.delete": { "post": { "summary": "Удалить дополнительный вид карточки v 3.0 crm.<тип>.detailpagelayout.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор дополнительного вида карточки — число в строке, например `\"17\"`. Личный и общий вид удалить нельзя." }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, от чьего имени проверить доступ к виду. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "id", "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор дополнительного вида карточки — число в строке, например `\"17\"`. Личный и общий вид удалить нельзя." }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, от чьего имени проверить доступ к виду. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "id", "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.get": { "post": { "summary": "Получить вид карточки v 3.0 crm.<тип>.detailpagelayout.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей личный вид вернуть или от чьего имени проверить доступ к дополнительному виду. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "id", "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей личный вид вернуть или от чьего имени проверить доступ к дополнительному виду. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "id", "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.getcommonlayoutid": { "post": { "summary": "Получить идентификатор общего вида карточки v 3.0 crm.<тип>.detailpagelayout.getcommonlayoutid", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_getcommonlayoutid", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-common-layout-id-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.getcurrent": { "post": { "summary": "Получить текущий вид карточки v 3.0 crm.<тип>.detailpagelayout.getcurrent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_getcurrent", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-current-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей текущий вид вернуть. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей текущий вид вернуть. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.getpersonallayoutid": { "post": { "summary": "Получить идентификатор личного вида карточки v 3.0 crm.<тип>.detailpagelayout.getpersonallayoutid", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_getpersonallayoutid", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-get-personal-layout-id-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.list": { "post": { "summary": "Получить список дополнительных видов карточки v 3.0 crm.<тип>.detailpagelayout.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": значение}` (подробное описание) ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого нужен список доступных видов. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "filter", "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": значение}` (подробное описание) ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого нужен список доступных видов. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "filter", "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.setcommonforall": { "post": { "summary": "Установить общий вид карточки для всех v 3.0 crm.<тип>.detailpagelayout.setcommonforall", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_setcommonforall", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-common-for-all-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." } }, "required": [ "categoryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.setcurrent": { "post": { "summary": "Установить текущий вид карточки v 3.0 crm.<тип>.detailpagelayout.setcurrent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_setcurrent", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-set-current-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "layoutId": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого выбрать вид. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "categoryId", "layoutId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "layoutId": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого выбрать вид. Передавать идентификатор другого пользователя может только администратор CRM." } }, "required": [ "categoryId", "layoutId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/detailpagelayout.update": { "post": { "summary": "Изменить вид карточки v 3.0 crm.<тип>.detailpagelayout.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "detailpagelayout_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/detail-page-layout/crm-entity-detail-page-layout-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей вид изменить. Нужен, чтобы изменить личный вид другого пользователя. Передавать идентификатор другого пользователя может только администратор CRM." }, "fields": { "type": "object", "description": "| Новые значения вида (подробное описание) ||" }, "configuration": { "type": "string", "description": "| Разделы карточки в порядке вывода (подробное описание). Массив заменяет все разделы вида, поэтому передавайте конфигурацию целиком. Текущую конфигурацию возвращает метод crm.<тип>.detailpagelayout.get ||" }, "audience": { "type": "string", "description": "| Новый список участников дополнительного вида, хотя бы один (подробное описание). Список заменяет прежний целиком. Пользователь, который вызывает метод, в аудиторию сам не попадает. У личного и общего вида аудитории нет ||" }, "title": { "type": "string", "description": "| Заголовок раздела в карточке ||" }, "elements": { "type": "string", "description": "| Поля раздела в порядке вывода (подробное описание). Можно передать пустой массив ||" }, "optionFlags": { "type": "integer", "description": "| Показывать ли поле, когда оно не заполнено." }, "options": { "type": "object", "description": "| Настройки поля в формате `{\"настройка\": \"значение\"}`, например `{\"defaultCountry\": \"RU\"}` для телефона. Набор настроек зависит от поля. Настройки полей есть в конфигурации вида, которую возвращает метод crm.<тип>.detailpagelayout.get ||" }, "type": { "type": "string", "description": "| Тип участника." } }, "required": [ "id", "categoryId", "fields", "title", "elements", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор вида карточки — строка:" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, чей вид изменить. Нужен, чтобы изменить личный вид другого пользователя. Передавать идентификатор другого пользователя может только администратор CRM." }, "fields": { "type": "object", "description": "| Новые значения вида (подробное описание) ||" }, "configuration": { "type": "string", "description": "| Разделы карточки в порядке вывода (подробное описание). Массив заменяет все разделы вида, поэтому передавайте конфигурацию целиком. Текущую конфигурацию возвращает метод crm.<тип>.detailpagelayout.get ||" }, "audience": { "type": "string", "description": "| Новый список участников дополнительного вида, хотя бы один (подробное описание). Список заменяет прежний целиком. Пользователь, который вызывает метод, в аудиторию сам не попадает. У личного и общего вида аудитории нет ||" }, "title": { "type": "string", "description": "| Заголовок раздела в карточке ||" }, "elements": { "type": "string", "description": "| Поля раздела в порядке вывода (подробное описание). Можно передать пустой массив ||" }, "optionFlags": { "type": "integer", "description": "| Показывать ли поле, когда оно не заполнено." }, "options": { "type": "object", "description": "| Настройки поля в формате `{\"настройка\": \"значение\"}`, например `{\"defaultCountry\": \"RU\"}` для телефона. Набор настроек зависит от поля. Настройки полей есть в конфигурации вида, которую возвращает метод crm.<тип>.detailpagelayout.get ||" }, "type": { "type": "string", "description": "| Тип участника." } }, "required": [ "id", "categoryId", "fields", "title", "elements", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/disk.attachedObject.get": { "post": { "summary": "Получить информацию о прикрепленном файле disk.attachedObject.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.attachedObject.get` возвращает информацию о прикрепленном файле.", "operationId": "disk_attachedObject_get", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/attached-object/disk-attached-object-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи о прикреплении файла, то есть связи, которая соединяет файл диска с другими объектами." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи о прикреплении файла, то есть связи, которая соединяет файл диска с другими объектами." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.copyTo": { "post": { "summary": "Копировать файл в указанную папку disk.file.copyTo", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.copyTo` копирует файл в указанную папку.", "operationId": "disk_file_copyTo", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-copy-to.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор папки, в которую копируется файл ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор папки, в которую копируется файл ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.delete": { "post": { "summary": "Удалить файл навсегда disk.file.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.delete` удаляет файл навсегда.", "operationId": "disk_file_delete", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.get": { "post": { "summary": "Получить параметры файла disk.file.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.get` возвращает данные о файле.", "operationId": "disk_file_get", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getExternalLink": { "post": { "summary": "Получить публичную ссылку на файл disk.file.getExternalLink", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.getExternalLink` возвращает публичную ссылку на файл.", "operationId": "disk_file_getExternalLink", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-get-external-link.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getFields": { "post": { "summary": "Получить описание полей файла disk.file.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.getFields` возвращает описание полей файла.", "operationId": "disk_file_getFields", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getVersions": { "post": { "summary": "Список версий файла disk.file.getVersions", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.getVersions` возвращает список версий файла.", "operationId": "disk_file_getVersions", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-get-versions.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.markDeleted": { "post": { "summary": "Переместить файл в корзину disk.file.markDeleted", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.markDeleted` перемещает файл в корзину.", "operationId": "disk_file_markDeleted", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-mark-deleted.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.moveTo": { "post": { "summary": "Переместить файл в указанную папку disk.file.moveTo", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.moveTo` перемещает файл в указанную папку.", "operationId": "disk_file_moveTo", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-move-to.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор папки, в которую нужно переместить файл ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор папки, в которую нужно переместить файл ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.rename": { "post": { "summary": "Переименовать файл disk.file.rename", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.rename` переименовывает файл.", "operationId": "disk_file_rename", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-rename.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "newName": { "type": "string", "description": "| Новое имя файла." } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "newName": { "type": "string", "description": "| Новое имя файла." } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.restore": { "post": { "summary": "Восстановить файл из корзины disk.file.restore", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.restore` восстанавливает файл из корзины.", "operationId": "disk_file_restore", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-restore.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла, находящегося в корзине." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла, находящегося в корзине." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.restoreFromVersion": { "post": { "summary": "Восстановить файл из конкретной версии disk.file.restoreFromVersion", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.restoreFromVersion` восстанавливает файл из конкретной версии.", "operationId": "disk_file_restoreFromVersion", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-restore-from-version.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "versionId": { "type": "integer", "description": "| Идентификатор версии файла." } }, "required": [ "id", "versionId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "versionId": { "type": "integer", "description": "| Идентификатор версии файла." } }, "required": [ "id", "versionId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.search": { "post": { "summary": "Найти файлы и папки disk.file.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.search` находит файлы и папки на Диске по текстовому запросу.", "operationId": "disk_file_search", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "QUERY": { "type": "string", "description": "| Текст поискового запроса." }, "TYPE": { "type": "string", "description": "| Тип объектов в результате:" }, "FILTER": { "type": "object", "description": "| Область поиска (подробное описание)." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "STORAGE_ID": { "type": "integer", "description": "| Необязательный ключ. Идентификатор хранилища, внутри которого нужно искать." }, "FOLDER_ID": { "type": "integer", "description": "| Необязательный ключ. Идентификатор папки, внутри которой нужно искать. Поиск идет и по вложенным папкам, сама папка в результат не попадает." } }, "required": [ "QUERY" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "QUERY": { "type": "string", "description": "| Текст поискового запроса." }, "TYPE": { "type": "string", "description": "| Тип объектов в результате:" }, "FILTER": { "type": "object", "description": "| Область поиска (подробное описание)." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "STORAGE_ID": { "type": "integer", "description": "| Необязательный ключ. Идентификатор хранилища, внутри которого нужно искать." }, "FOLDER_ID": { "type": "integer", "description": "| Необязательный ключ. Идентификатор папки, внутри которой нужно искать. Поиск идет и по вложенным папкам, сама папка в результат не попадает." } }, "required": [ "QUERY" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.uploadVersion": { "post": { "summary": "Загрузить новую версию файла disk.file.uploadVersion", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.file.uploadVersion` загружает новую версию файла.", "operationId": "disk_file_uploadVersion", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-upload-version.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "fileContent": { "type": "array", "items": {}, "description": "| Содержимое новой версии (подробное описание) ||" } }, "required": [ "id", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "fileContent": { "type": "array", "items": {}, "description": "| Содержимое новой версии (подробное описание) ||" } }, "required": [ "id", "fileContent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.addSubFolder": { "post": { "summary": "Создать дочернюю папку disk.folder.addSubFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.addSubFolder` создает дочернюю папку.", "operationId": "disk_folder_addSubFolder", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-add-subfolder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор родительской папки." }, "data": { "type": "object", "description": "| Параметры дочерней папки (подробное описание) ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на папку. Каждый элемент содержит:" } }, "required": [ "id", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор родительской папки." }, "data": { "type": "object", "description": "| Параметры дочерней папки (подробное описание) ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на папку. Каждый элемент содержит:" } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.copyTo": { "post": { "summary": "Копировать папку и все ее содержимое в указанную папку disk.folder.copyTo", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.copyTo` копирует папку и все ее содержимое в указанную папку. В ответе возвращается только объект новой корневой папки копии. Ее содержимое можно получить методом [disk.folder.getChildren](./disk-folder-get-children.md).", "operationId": "disk_folder_copyTo", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-copy-to.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор исходной папки, которую нужно скопировать." }, "targetFolderId": { "type": "integer", "description": "| Идентификатор целевой папки, куда копируется папка ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор исходной папки, которую нужно скопировать." }, "targetFolderId": { "type": "integer", "description": "| Идентификатор целевой папки, куда копируется папка ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.deleteTree": { "post": { "summary": "Удалить папку и все ее содержимое навсегда disk.folder.deleteTree", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.deleteTree` удаляет папку и все ее содержимое навсегда.", "operationId": "disk_folder_deleteTree", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-delete-tree.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.get": { "post": { "summary": "Получить параметры папки disk.folder.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.get` возвращает данные о папке.", "operationId": "disk_folder_get", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getChildren": { "post": { "summary": "Получить список файлов и папок, находящихся в папке disk.folder.getChildren", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.getChildren` возвращает список файлов и папок, которые находятся в папке.", "operationId": "disk_folder_getChildren", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-get-children.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getExternalLink": { "post": { "summary": "Получить публичную ссылку на папку disk.folder.getExternalLink", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.getExternalLink` возвращает действующую публичную ссылку на папку. Если ссылки нет или срок ее действия истек, метод создает новую. Пока ссылка действует, повторные вызовы возвращают то же значение.", "operationId": "disk_folder_getExternalLink", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-get-external-link.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getFields": { "post": { "summary": "Получить описание полей папки disk.folder.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.getFields` возвращает описание полей папки.", "operationId": "disk_folder_getFields", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.markDeleted": { "post": { "summary": "Переместить папку в корзину disk.folder.markDeleted", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.markDeleted` перемещает папку в корзину.", "operationId": "disk_folder_markDeleted", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-mark-deleted.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.moveTo": { "post": { "summary": "Переместить папку и все ее содержимое в указанную папку disk.folder.moveTo", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.moveTo` перемещает папку и все ее содержимое в указанную папку.", "operationId": "disk_folder_moveTo", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-move-to.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор исходной папки, которую нужно переместить ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор целевой папки, куда перемещается папка." } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор исходной папки, которую нужно переместить ||" }, "targetFolderId": { "type": "integer", "description": "| Идентификатор целевой папки, куда перемещается папка." } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.rename": { "post": { "summary": "Переименовать папку disk.folder.rename", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.rename` переименовывает папку.", "operationId": "disk_folder_rename", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-rename.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "newName": { "type": "string", "description": "| Новое имя папки. Максимальная длина — 255 символов. Имя не должно содержать символы, запрещенные в именах файлов ||" } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "newName": { "type": "string", "description": "| Новое имя папки. Максимальная длина — 255 символов. Имя не должно содержать символы, запрещенные в именах файлов ||" } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.restore": { "post": { "summary": "Восстановить папку из корзины disk.folder.restore", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.restore` восстанавливает папку из корзины.", "operationId": "disk_folder_restore", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-restore.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки, находящейся в корзине." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки, находящейся в корзине." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.shareToUser": { "post": { "summary": "Назначить права доступа на папку disk.folder.shareToUser", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.shareToUser` назначает права доступа на папку.", "operationId": "disk_folder_shareToUser", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-share-to-user.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, которому выдается доступ." }, "taskName": { "type": "string", "description": "| Уровень прав, который выдается пользователю. Возможные значения:" } }, "required": [ "id", "userId", "taskName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, которому выдается доступ." }, "taskName": { "type": "string", "description": "| Уровень прав, который выдается пользователю. Возможные значения:" } }, "required": [ "id", "userId", "taskName" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.uploadFile": { "post": { "summary": "Загрузить новый файл в указанную папку disk.folder.uploadFile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.folder.uploadFile` загружает новый файл в указанную папку.", "operationId": "disk_folder_uploadFile", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/folder/disk-folder-upload-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки, в которую нужно загрузить файл." }, "data": { "type": "object", "description": "| Параметры нового файла (подробное описание)" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из имени файла и строки с Base64." }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на загружаемый файл. Каждый элемент содержит:" }, "generateUniqueName": { "type": "boolean", "description": "| Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор папки, в которую нужно загрузить файл." }, "data": { "type": "object", "description": "| Параметры нового файла (подробное описание)" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из имени файла и строки с Base64." }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на загружаемый файл. Каждый элемент содержит:" }, "generateUniqueName": { "type": "boolean", "description": "| Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.rights.getTasks": { "post": { "summary": "Получить список доступных уровней доступа disk.rights.getTasks", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.rights.getTasks` возвращает список доступных уровней доступа.", "operationId": "disk_rights_getTasks", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/rights/disk-rights-get-tasks.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.addFolder": { "post": { "summary": "Создать папку в корне хранилища disk.storage.addFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.addFolder` создает папку в корне хранилища.", "operationId": "disk_storage_addFolder", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-add-folder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." }, "data": { "type": "object", "description": "| Параметры новой папки (подробное описание) ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на папку. Каждый элемент содержит:" } }, "required": [ "id", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." }, "data": { "type": "object", "description": "| Параметры новой папки (подробное описание) ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на папку. Каждый элемент содержит:" } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.get": { "post": { "summary": "Получить описание хранилища disk.storage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.get` возвращает данные хранилища.", "operationId": "disk_storage_get", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getChildren": { "post": { "summary": "Получить список файлов и папок в корне хранилища disk.storage.getChildren", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.getChildren` возвращает список файлов и папок, которые находятся в корне хранилища.", "operationId": "disk_storage_getChildren", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get-children.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища." }, "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getFields": { "post": { "summary": "Получить описание полей хранилища disk.storage.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.getFields` возвращает описание полей хранилища.", "operationId": "disk_storage_getFields", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getForApp": { "post": { "summary": "Получить описание хранилища приложения disk.storage.getForApp", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.getForApp` возвращает описание хранилища, привязанного к приложению. Если хранилища нет — создает его.", "operationId": "disk_storage_getForApp", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get-for-app.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getList": { "post": { "summary": "Получить список доступных хранилищ disk.storage.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.getList` возвращает список доступных хранилищ.", "operationId": "disk_storage_getList", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Массив формата:" }, "order": { "type": "array", "items": {}, "description": "| Массив формата:" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getTypes": { "post": { "summary": "Получить типы хранилищ disk.storage.getTypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.getTypes` возвращает список типов хранилищ.", "operationId": "disk_storage_getTypes", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-get-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.rename": { "post": { "summary": "Переименовать хранилище приложения disk.storage.rename", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.rename` переименовывает хранилище приложения.", "operationId": "disk_storage_rename", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-rename.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища приложения." }, "newName": { "type": "string", "description": "| Новое имя хранилища. Максимальная длина — 100 символов ||" } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища приложения." }, "newName": { "type": "string", "description": "| Новое имя хранилища. Максимальная длина — 100 символов ||" } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.uploadFile": { "post": { "summary": "Загрузить новый файл в корень хранилища disk.storage.uploadFile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.storage.uploadFile` загружает новый файл в корень хранилища.", "operationId": "disk_storage_uploadFile", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/storage/disk-storage-upload-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища, в которое нужно загрузить файл." }, "data": { "type": "object", "description": "| Параметры нового файла (подробное описание) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из имени файла и строки с Base64 ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на загружаемый файл. Каждый элемент содержит:" }, "generateUniqueName": { "type": "boolean", "description": "| Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx." } }, "required": [ "id", "data", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор хранилища, в которое нужно загрузить файл." }, "data": { "type": "object", "description": "| Параметры нового файла (подробное описание) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| Массив из имени файла и строки с Base64 ||" }, "rights": { "type": "array", "items": {}, "description": "| Массив прав доступа на загружаемый файл. Каждый элемент содержит:" }, "generateUniqueName": { "type": "boolean", "description": "| Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx." } }, "required": [ "id", "data", "fileContent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.version.get": { "post": { "summary": "Получить версию файла disk.version.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `disk.version.get` возвращает версию файла.", "operationId": "disk_version_get", "tags": [ "Диск" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/disk/version/disk-version-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор версии файла." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор версии файла." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/documentgenerator.document.add": { "post": { "summary": "Создать новый документ на основании шаблона documentgenerator.document.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.add` создает новый документ на основании шаблона.", "operationId": "documentgenerator_document_add", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона." }, "providerClassName": { "type": "string", "description": "| Класс провайдера данных." }, "value": { "type": "string", "description": "| Внешний идентификатор объекта, для которого формируется документ." }, "values": { "type": "object", "description": "| Значения полей документа вида `{\"КодПоля\":\"Значение\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Режим печатей и подписей:" }, "fields": { "type": "object", "description": "| Описание того, как интерпретировать и форматировать значения из `values` (подробное описание)." }, "TYPE": { "type": "string", "description": "| Тип поля." }, "FORMAT": { "type": "object", "description": "| Параметры формата для типа поля." }, "PROVIDER": { "type": "string", "description": "| Класс провайдера ||" }, "TITLE": { "type": "string", "description": "| Название поля ||" } }, "required": [ "templateId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона." }, "providerClassName": { "type": "string", "description": "| Класс провайдера данных." }, "value": { "type": "string", "description": "| Внешний идентификатор объекта, для которого формируется документ." }, "values": { "type": "object", "description": "| Значения полей документа вида `{\"КодПоля\":\"Значение\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Режим печатей и подписей:" }, "fields": { "type": "object", "description": "| Описание того, как интерпретировать и форматировать значения из `values` (подробное описание)." }, "TYPE": { "type": "string", "description": "| Тип поля." }, "FORMAT": { "type": "object", "description": "| Параметры формата для типа поля." }, "PROVIDER": { "type": "string", "description": "| Класс провайдера ||" }, "TITLE": { "type": "string", "description": "| Название поля ||" } }, "required": [ "templateId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.delete": { "post": { "summary": "Удалить документ documentgenerator.document.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.delete` удаляет документ по идентификатору.", "operationId": "documentgenerator_document_delete", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.enablepublicurl": { "post": { "summary": "Включить или выключить публичную ссылку на документ documentgenerator.document.enablepublicurl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.enablepublicurl` включает или выключает публичную ссылку на документ.", "operationId": "documentgenerator_document_enablepublicurl", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-enable-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "status": { "type": "integer", "description": "| Статус публичной ссылки:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "status": { "type": "integer", "description": "| Статус публичной ссылки:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.get": { "post": { "summary": "Получить документ по идентификатору documentgenerator.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.get` возвращает информацию о документе по его идентификатору.", "operationId": "documentgenerator_document_get", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.getfields": { "post": { "summary": "Получить список полей документа documentgenerator.document.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.getfields` возвращает поля документа, их текущие и базовые значения.", "operationId": "documentgenerator_document_getfields", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "values": { "type": "object", "description": "| Значения полей вида `{\"КодПоля\":\"Значение\"}`, например `{\"Title\":\"Договор поставки\"}`. Метод подставляет их только в ответ — документ не изменяется." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "values": { "type": "object", "description": "| Значения полей вида `{\"КодПоля\":\"Значение\"}`, например `{\"Title\":\"Договор поставки\"}`. Метод подставляет их только в ответ — документ не изменяется." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.list": { "post": { "summary": "Получить список документов documentgenerator.document.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.list` возвращает список документов по фильтру.", "operationId": "documentgenerator_document_list", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые нужно вернуть." }, "order": { "type": "object", "description": "| Объект для сортировки документов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации документов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "integer", "description": "| Идентификатор документа ||" }, "title": { "type": "string", "description": "| Название документа ||" }, "number": { "type": "string", "description": "| Номер документа ||" }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона ||" }, "provider": { "type": "string", "description": "| Класс провайдера ||" }, "value": { "type": "string", "description": "| Внешний идентификатор объекта ||" }, "fileId": { "type": "integer", "description": "| Идентификатор DOCX-файла документа ||" }, "imageId": { "type": "integer", "description": "| Идентификатор файла изображения документа ||" }, "pdfId": { "type": "integer", "description": "| Идентификатор PDF-файла документа ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Время создания документа ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Время обновления документа ||" }, "values": { "type": "object", "description": "| Значения полей документа ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал документ ||" }, "updatedBy": { "type": "integer", "description": "| Идентификатор пользователя, который обновил документ ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые нужно вернуть." }, "order": { "type": "object", "description": "| Объект для сортировки документов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации документов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "integer", "description": "| Идентификатор документа ||" }, "title": { "type": "string", "description": "| Название документа ||" }, "number": { "type": "string", "description": "| Номер документа ||" }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона ||" }, "provider": { "type": "string", "description": "| Класс провайдера ||" }, "value": { "type": "string", "description": "| Внешний идентификатор объекта ||" }, "fileId": { "type": "integer", "description": "| Идентификатор DOCX-файла документа ||" }, "imageId": { "type": "integer", "description": "| Идентификатор файла изображения документа ||" }, "pdfId": { "type": "integer", "description": "| Идентификатор PDF-файла документа ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Время создания документа ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Время обновления документа ||" }, "values": { "type": "object", "description": "| Значения полей документа ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создал документ ||" }, "updatedBy": { "type": "integer", "description": "| Идентификатор пользователя, который обновил документ ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.update": { "post": { "summary": "Изменить существующий документ documentgenerator.document.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.document.update` обновляет документ новыми значениями полей.", "operationId": "documentgenerator_document_update", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/document-generator-document-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "values": { "type": "object", "description": "| Значения полей документа вида `{\"КодПоля\":\"Значение\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Режим печатей и подписей:" }, "fields": { "type": "object", "description": "| Описание того, как интерпретировать и форматировать значения из `values` (подробное описание)." }, "TYPE": { "type": "string", "description": "| Тип поля." }, "FORMAT": { "type": "object", "description": "| Параметры формата для типа поля." }, "PROVIDER": { "type": "string", "description": "| Класс провайдера ||" }, "TITLE": { "type": "string", "description": "| Название поля ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "values": { "type": "object", "description": "| Значения полей документа вида `{\"КодПоля\":\"Значение\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Режим печатей и подписей:" }, "fields": { "type": "object", "description": "| Описание того, как интерпретировать и форматировать значения из `values` (подробное описание)." }, "TYPE": { "type": "string", "description": "| Тип поля." }, "FORMAT": { "type": "object", "description": "| Параметры формата для типа поля." }, "PROVIDER": { "type": "string", "description": "| Класс провайдера ||" }, "TITLE": { "type": "string", "description": "| Название поля ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.add": { "post": { "summary": "Добавить нумератор documentgenerator.numerator.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.numerator.add` создает нумератор документов.", "operationId": "documentgenerator_numerator_add", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/numerators/document-generator-numerator-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор параметров нумератора (подробное описание) ||" }, "template": { "type": "string", "description": "| Шаблон номера с плейсхолдером `{NUMBER}`." }, "settings": { "type": "object", "description": "| Настройки генераторов нумератора (подробное описание) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации (подробное описание) ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика." }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика." }, "length": { "type": "integer", "description": "| Минимальная длина номера." }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`." }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации." } }, "required": [ "fields", "template" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор параметров нумератора (подробное описание) ||" }, "template": { "type": "string", "description": "| Шаблон номера с плейсхолдером `{NUMBER}`." }, "settings": { "type": "object", "description": "| Настройки генераторов нумератора (подробное описание) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации (подробное описание) ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика." }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика." }, "length": { "type": "integer", "description": "| Минимальная длина номера." }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`." }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации." } }, "required": [ "fields", "template" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.delete": { "post": { "summary": "Удалить нумератор documentgenerator.numerator.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.numerator.delete` удаляет нумератор по идентификатору.", "operationId": "documentgenerator_numerator_delete", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/numerators/document-generator-numerator-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.get": { "post": { "summary": "Получить нумератор по идентификатору documentgenerator.numerator.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.numerator.get` возвращает данные нумератора по идентификатору.", "operationId": "documentgenerator_numerator_get", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/numerators/document-generator-numerator-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.list": { "post": { "summary": "Получить список нумераторов documentgenerator.numerator.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.numerator.list` возвращает постраничный список нумераторов для генератора документов. В выборку входят доступные нумераторы этого типа, в том числе [CRM нумераторы](../../crm/document-generator/numerator/index.md).", "operationId": "documentgenerator_numerator_list", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/numerators/document-generator-numerator-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.update": { "post": { "summary": "Изменить нумератор documentgenerator.numerator.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.numerator.update` обновляет нумератор по идентификатору.", "operationId": "documentgenerator_numerator_update", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/numerators/document-generator-numerator-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." }, "fields": { "type": "object", "description": "| Набор полей для обновления (подробное описание) ||" }, "template": { "type": "string", "description": "| Новый шаблон номера с плейсхолдером `{NUMBER}`." }, "settings": { "type": "object", "description": "| Обновленные настройки генераторов (подробное описание) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации (подробное описание) ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `0` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор нумератора." }, "fields": { "type": "object", "description": "| Набор полей для обновления (подробное описание) ||" }, "template": { "type": "string", "description": "| Новый шаблон номера с плейсхолдером `{NUMBER}`." }, "settings": { "type": "object", "description": "| Обновленные настройки генераторов (подробное описание) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Настройки последовательной нумерации (подробное описание) ||" }, "start": { "type": "integer", "description": "| Начальное значение счетчика. По умолчанию `1` ||" }, "step": { "type": "integer", "description": "| Шаг увеличения счетчика. По умолчанию `1` ||" }, "length": { "type": "integer", "description": "| Минимальная длина номера. По умолчанию `0` ||" }, "padString": { "type": "string", "description": "| Символ добивки слева при `length > 0`. По умолчанию `0` ||" }, "periodicBy": { "type": "string", "description": "| Период сброса счетчика:" }, "timezone": { "type": "string", "description": "| Идентификатор часового пояса для периодического сброса, например `Europe/Moscow` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Признак прямой нумерации." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.add": { "post": { "summary": "Добавить регион documentgenerator.region.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.region.add` добавляет новый пользовательский регион.", "operationId": "documentgenerator_region_add", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/region/document-generator-region-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Параметры региона (подробное описание) ||" }, "title": { "type": "string", "description": "| Название региона ||" }, "languageId": { "type": "string", "description": "| Идентификатор языка региона, например, `ru` ||" }, "formatDate": { "type": "string", "description": "| Формат даты ||" }, "formatDatetime": { "type": "string", "description": "| Формат даты и времени ||" }, "formatName": { "type": "string", "description": "| Шаблон полного имени, например, `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Набор локализованных фраз региона в формате `код: текст`." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Параметры региона (подробное описание) ||" }, "title": { "type": "string", "description": "| Название региона ||" }, "languageId": { "type": "string", "description": "| Идентификатор языка региона, например, `ru` ||" }, "formatDate": { "type": "string", "description": "| Формат даты ||" }, "formatDatetime": { "type": "string", "description": "| Формат даты и времени ||" }, "formatName": { "type": "string", "description": "| Шаблон полного имени, например, `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Набор локализованных фраз региона в формате `код: текст`." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.delete": { "post": { "summary": "Удалить регион documentgenerator.region.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.region.delete` удаляет пользовательский регион по идентификатору.", "operationId": "documentgenerator_region_delete", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/region/document-generator-region-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского региона." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского региона." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.get": { "post": { "summary": "Получить регион по идентификатору documentgenerator.region.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.region.get` возвращает данные региона по идентификатору или коду.", "operationId": "documentgenerator_region_get", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/region/document-generator-region-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор пользовательского региона или код предустановленного региона, например, `ru`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор пользовательского региона или код предустановленного региона, например, `ru`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.list": { "post": { "summary": "Получить список регионов documentgenerator.region.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.region.list` возвращает список предустановленных и пользовательских регионов.", "operationId": "documentgenerator_region_list", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/region/document-generator-region-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.update": { "post": { "summary": "Изменить регион documentgenerator.region.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.region.update` обновляет пользовательский регион по идентификатору.", "operationId": "documentgenerator_region_update", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/region/document-generator-region-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского региона." }, "fields": { "type": "object", "description": "| Параметры для обновления (подробное описание) ||" }, "title": { "type": "string", "description": "| Новое название региона ||" }, "languageId": { "type": "string", "description": "| Идентификатор языка региона, например `ru` ||" }, "formatDate": { "type": "string", "description": "| Формат даты ||" }, "formatDatetime": { "type": "string", "description": "| Формат даты и времени ||" }, "formatName": { "type": "string", "description": "| Шаблон полного имени, например `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Набор фраз региона в формате `код: текст`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского региона." }, "fields": { "type": "object", "description": "| Параметры для обновления (подробное описание) ||" }, "title": { "type": "string", "description": "| Новое название региона ||" }, "languageId": { "type": "string", "description": "| Идентификатор языка региона, например `ru` ||" }, "formatDate": { "type": "string", "description": "| Формат даты ||" }, "formatDatetime": { "type": "string", "description": "| Формат даты и времени ||" }, "formatName": { "type": "string", "description": "| Шаблон полного имени, например `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Набор фраз региона в формате `код: текст`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.add": { "post": { "summary": "Добавить роль documentgenerator.role.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.add` добавляет новую роль.", "operationId": "documentgenerator_role_add", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля роли (подробное описание) ||" }, "code": { "type": "string", "description": "| Символьный код роли ||" }, "permissions": { "type": "object", "description": "| Права роли (подробное описание)." }, "SETTINGS": { "type": "object", "description": "| Права на настройки (подробное описание) ||" }, "TEMPLATES": { "type": "object", "description": "| Права на шаблоны (подробное описание) ||" }, "DOCUMENTS": { "type": "object", "description": "| Права на документы (подробное описание) ||" }, "MODIFY": { "type": "string", "description": "| Уровень доступа к настройкам. Возможные значения:" }, "VIEW": { "type": "string", "description": "| Уровень доступа на просмотр документов. Возможные значения:" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля роли (подробное описание) ||" }, "code": { "type": "string", "description": "| Символьный код роли ||" }, "permissions": { "type": "object", "description": "| Права роли (подробное описание)." }, "SETTINGS": { "type": "object", "description": "| Права на настройки (подробное описание) ||" }, "TEMPLATES": { "type": "object", "description": "| Права на шаблоны (подробное описание) ||" }, "DOCUMENTS": { "type": "object", "description": "| Права на документы (подробное описание) ||" }, "MODIFY": { "type": "string", "description": "| Уровень доступа к настройкам. Возможные значения:" }, "VIEW": { "type": "string", "description": "| Уровень доступа на просмотр документов. Возможные значения:" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.delete": { "post": { "summary": "Удалить роль documentgenerator.role.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.delete` удаляет роль по идентификатору.", "operationId": "documentgenerator_role_delete", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.fillaccesses": { "post": { "summary": "Привязать пользователей к ролям documentgenerator.role.fillaccesses", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.fillaccesses` полностью перезаписывает карту привязок ролей к кодам доступа.", "operationId": "documentgenerator_role_fillaccesses", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-fill-accesses.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accesses": { "type": "array", "items": {}, "description": "| Массив привязок роли к коду доступа (подробное описание) ||" }, "roleId": { "type": "integer", "description": "| Идентификатор роли." }, "accessCode": { "type": "string", "description": "| Код доступа пользователя, группы или отдела." } }, "required": [ "roleId", "accessCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "accesses": { "type": "array", "items": {}, "description": "| Массив привязок роли к коду доступа (подробное описание) ||" }, "roleId": { "type": "integer", "description": "| Идентификатор роли." }, "accessCode": { "type": "string", "description": "| Код доступа пользователя, группы или отдела." } }, "required": [ "roleId", "accessCode" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.get": { "post": { "summary": "Получить роль по идентификатору documentgenerator.role.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.get` возвращает информацию о роли и ее правах доступа.", "operationId": "documentgenerator_role_get", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.list": { "post": { "summary": "Получить список ролей documentgenerator.role.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.list` возвращает список ролей без детализации прав.", "operationId": "documentgenerator_role_list", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.update": { "post": { "summary": "Изменить роль documentgenerator.role.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.role.update` обновляет роль по идентификатору.", "operationId": "documentgenerator_role_update", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." }, "fields": { "type": "object", "description": "| Набор полей для обновления (подробное описание) ||" }, "code": { "type": "string", "description": "| Новый символьный код роли ||" }, "permissions": { "type": "object", "description": "| Новый набор прав роли (подробное описание)." }, "SETTINGS": { "type": "object", "description": "| Права на настройки (подробное описание) ||" }, "TEMPLATES": { "type": "object", "description": "| Права на шаблоны (подробное описание) ||" }, "DOCUMENTS": { "type": "object", "description": "| Права на документы (подробное описание) ||" }, "MODIFY": { "type": "string", "description": "| Уровень доступа к настройкам. Возможные значения:" }, "VIEW": { "type": "string", "description": "| Уровень доступа на просмотр документов. Возможные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор роли." }, "fields": { "type": "object", "description": "| Набор полей для обновления (подробное описание) ||" }, "code": { "type": "string", "description": "| Новый символьный код роли ||" }, "permissions": { "type": "object", "description": "| Новый набор прав роли (подробное описание)." }, "SETTINGS": { "type": "object", "description": "| Права на настройки (подробное описание) ||" }, "TEMPLATES": { "type": "object", "description": "| Права на шаблоны (подробное описание) ||" }, "DOCUMENTS": { "type": "object", "description": "| Права на документы (подробное описание) ||" }, "MODIFY": { "type": "string", "description": "| Уровень доступа к настройкам. Возможные значения:" }, "VIEW": { "type": "string", "description": "| Уровень доступа на просмотр документов. Возможные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.add": { "post": { "summary": "Загрузить шаблон documentgenerator.template.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.add` добавляет новый шаблон документа.", "operationId": "documentgenerator_template_add", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей шаблона (подробное описание) ||" }, "fileId": { "type": "integer", "description": "| Идентификатор ранее загруженного файла шаблона с Диска." }, "file": { "type": "string", "description": "| Файл шаблона, если его нужно загрузить. Используется вместо параметра `fileId`." }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора." }, "region": { "type": "string", "description": "| Регион шаблона, например, `ru` ||" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "users": { "type": "array", "items": {}, "description": "| Пользователи, у которых будет доступ к шаблону." }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона. Возможные значения:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печати и подписи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "timezone": { "type": "string", "description": "| Часовой пояс, в котором выводятся даты в документах по шаблону. Передается идентификатор часового пояса IANA, например `Europe/Moscow`." } }, "required": [ "fields", "fileId", "file", "numeratorId", "region" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Набор полей шаблона (подробное описание) ||" }, "fileId": { "type": "integer", "description": "| Идентификатор ранее загруженного файла шаблона с Диска." }, "file": { "type": "string", "description": "| Файл шаблона, если его нужно загрузить. Используется вместо параметра `fileId`." }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора." }, "region": { "type": "string", "description": "| Регион шаблона, например, `ru` ||" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "users": { "type": "array", "items": {}, "description": "| Пользователи, у которых будет доступ к шаблону." }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона. Возможные значения:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печати и подписи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "timezone": { "type": "string", "description": "| Часовой пояс, в котором выводятся даты в документах по шаблону. Передается идентификатор часового пояса IANA, например `Europe/Moscow`." } }, "required": [ "fields", "fileId", "file", "numeratorId", "region" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.delete": { "post": { "summary": "Удалить шаблон documentgenerator.template.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.delete` удаляет шаблон.", "operationId": "documentgenerator_template_delete", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.get": { "post": { "summary": "Получить шаблон по идентификатору documentgenerator.template.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.get` возвращает информацию о шаблоне по его идентификатору.", "operationId": "documentgenerator_template_get", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.getfields": { "post": { "summary": "Получить список полей шаблона documentgenerator.template.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.getfields` возвращает карточку полей шаблона.", "operationId": "documentgenerator_template_getfields", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.list": { "post": { "summary": "Получить список шаблонов documentgenerator.template.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.list` возвращает список шаблонов по фильтру.", "operationId": "documentgenerator_template_list", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть. По умолчанию — `[\"*\"]`." }, "order": { "type": "object", "description": "| Объект для сортировки шаблонов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации шаблонов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "integer", "description": "| Идентификатор шаблона ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона. Возможные значения:" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "region": { "type": "string", "description": "| Регион шаблона ||" }, "timezone": { "type": "string", "description": "| Часовой пояс шаблона в формате IANA, например `Europe/Moscow` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Дата и время создания ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Дата и время обновления ||" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Использование печатей и подписей. Возможные значения:" }, "users": { "type": "array", "items": {}, "description": "| Коды доступа к шаблону. Только для `select` ||" }, "providers": { "type": "array", "items": {}, "description": "| Провайдеры данных шаблона. Только для `select` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть. По умолчанию — `[\"*\"]`." }, "order": { "type": "object", "description": "| Объект для сортировки шаблонов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| Объект для фильтрации шаблонов в формате `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "id": { "type": "integer", "description": "| Идентификатор шаблона ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность шаблона. Возможные значения:" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "region": { "type": "string", "description": "| Регион шаблона ||" }, "timezone": { "type": "string", "description": "| Часовой пояс шаблона в формате IANA, например `Europe/Moscow` ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Дата и время создания ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Дата и время обновления ||" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Использование печатей и подписей. Возможные значения:" }, "users": { "type": "array", "items": {}, "description": "| Коды доступа к шаблону. Только для `select` ||" }, "providers": { "type": "array", "items": {}, "description": "| Провайдеры данных шаблона. Только для `select` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.update": { "post": { "summary": "Изменить шаблон documentgenerator.template.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `documentgenerator.template.update` обновляет существующий шаблон.", "operationId": "documentgenerator_template_update", "tags": [ "Генератор документов" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/document-generator/templates/document-generator-template-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." }, "fields": { "type": "object", "description": "| Поля шаблона для обновления (подробное описание) ||" }, "file": { "type": "string", "description": "| Новый файл шаблона. Можно передать тремя способами:" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "region": { "type": "string", "description": "| Регион шаблона, например `ru` ||" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "users": { "type": "array", "items": {}, "description": "| Пользователи, у которых будет доступ к шаблону." }, "providers": { "type": "array", "items": {}, "description": "| Список провайдеров данных ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность. Возможные значения:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печати и подписи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "timezone": { "type": "string", "description": "| Часовой пояс, в котором выводятся даты в документах по шаблону. Передается идентификатор часового пояса IANA, например `Europe/Moscow`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." }, "fields": { "type": "object", "description": "| Поля шаблона для обновления (подробное описание) ||" }, "file": { "type": "string", "description": "| Новый файл шаблона. Можно передать тремя способами:" }, "numeratorId": { "type": "integer", "description": "| Идентификатор нумератора ||" }, "region": { "type": "string", "description": "| Регион шаблона, например `ru` ||" }, "code": { "type": "string", "description": "| Символьный код шаблона ||" }, "users": { "type": "array", "items": {}, "description": "| Пользователи, у которых будет доступ к шаблону." }, "providers": { "type": "array", "items": {}, "description": "| Список провайдеров данных ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Активность. Возможные значения:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Подставлять печати и подписи. Возможные значения:" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "timezone": { "type": "string", "description": "| Часовой пояс, в котором выводятся даты в документах по шаблону. Передается идентификатор часового пояса IANA, например `Europe/Moscow`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/entity.add": { "post": { "summary": "Создать хранилище данных entity.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.add` создает новое хранилище данных приложения.", "operationId": "entity_add", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Права доступа в формате `{\"код_доступа\":\"уровень_права\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Права доступа в формате `{\"код_доступа\":\"уровень_права\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.delete": { "post": { "summary": "Удалить хранилище entity.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.delete` удаляет хранилище данных приложения.", "operationId": "entity_delete", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.get": { "post": { "summary": "Получить параметры хранилища или список хранилищ entity.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.get` возвращает параметры указанного хранилища или список всех хранилищ приложения.", "operationId": "entity_get", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY": { "type": "string", "description": "| Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY": { "type": "string", "description": "| Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.add": { "post": { "summary": "Добавить элемент в хранилище entity.item.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.add` добавляет элемент в хранилище данных приложения.", "operationId": "entity_item_add", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/entity-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY_VALUES": { "type": "object", "description": "| Значения свойств элемента в формате `{\"КОД_СВОЙСТВА\": значение}`." }, "SECTION": { "type": "integer", "description": "| Идентификатор раздела хранилища ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Дата начала активности элемента ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| Дата окончания активности элемента ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка анонса элемента. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка элемента. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля элемента `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY_VALUES": { "type": "object", "description": "| Значения свойств элемента в формате `{\"КОД_СВОЙСТВА\": значение}`." }, "SECTION": { "type": "integer", "description": "| Идентификатор раздела хранилища ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Дата начала активности элемента ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| Дата окончания активности элемента ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка анонса элемента. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка элемента. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля элемента `UF_*`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.delete": { "post": { "summary": "Удалить элемент хранилища entity.item.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.delete` удаляет элемент хранилища данных приложения.", "operationId": "entity_item_delete", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/entity-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.get": { "post": { "summary": "Получить список элементов хранилища entity.item.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.get` получает список элементов хранилища данных приложения.", "operationId": "entity_item_get", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/entity-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Объект формата:" }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Объект формата:" }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.add": { "post": { "summary": "Добавить свойство элементов хранилища entity.item.property.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.property.add` добавляет свойство элементов хранилища данных приложения.", "operationId": "entity_item_property_add", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/properties/entity-item-property-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Тип свойства:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки свойства ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Тип свойства:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки свойства ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.delete": { "post": { "summary": "Удалить свойство элементов хранилища entity.item.property.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.property.delete` удаляет свойство элементов хранилища данных приложения.", "operationId": "entity_item_property_delete", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/properties/entity-item-property-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.get": { "post": { "summary": "Получить свойства элементов хранилища entity.item.property.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.property.get` возвращает свойства элементов хранилища данных приложения.", "operationId": "entity_item_property_get", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/properties/entity-item-property-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY": { "type": "string", "description": "| Код свойства." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY": { "type": "string", "description": "| Код свойства." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.update": { "post": { "summary": "Изменить свойство элементов хранилища entity.item.property.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.item.property.update` изменяет свойство элементов хранилища данных приложения.", "operationId": "entity_item_property_update", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/properties/entity-item-property-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY_NEW": { "type": "string", "description": "| Новый код свойства." }, "TYPE": { "type": "string", "description": "| Новый тип свойства:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки свойства ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY_NEW": { "type": "string", "description": "| Новый код свойства." }, "TYPE": { "type": "string", "description": "| Новый тип свойства:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки свойства ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.update": { "post": { "summary": "Обновить элемент хранилища entity.item.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод работает только в контексте [приложения](../../../settings/app-installation/index.md).", "operationId": "entity_item_update", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/items/entity-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY_VALUES": { "type": "object", "description": "| Значения свойств элемента в формате `{\"КОД_СВОЙСТВА\": значение}`." }, "SECTION": { "type": "integer", "description": "| Идентификатор раздела хранилища ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Дата начала активности элемента ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| Дата окончания активности элемента ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка анонса элемента. Формат файла — в статье Как загрузить файлы." }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка элемента. Формат файла — в статье Как загрузить файлы." }, "UF_": { "type": "string", "description": "| Пользовательские поля элемента `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY_VALUES": { "type": "object", "description": "| Значения свойств элемента в формате `{\"КОД_СВОЙСТВА\": значение}`." }, "SECTION": { "type": "integer", "description": "| Идентификатор раздела хранилища ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Дата начала активности элемента ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| Дата окончания активности элемента ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Картинка анонса элемента. Формат файла — в статье Как загрузить файлы." }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка элемента. Формат файла — в статье Как загрузить файлы." }, "UF_": { "type": "string", "description": "| Пользовательские поля элемента `UF_*`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.rights": { "post": { "summary": "Получить или изменить права доступа entity.rights", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.rights` получает текущий набор прав доступа к хранилищу данных приложения или изменяет его.", "operationId": "entity_rights", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-rights.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Новый набор прав в формате `{\"код_доступа\":\"уровень_права\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Новый набор прав в формате `{\"код_доступа\":\"уровень_права\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.add": { "post": { "summary": "Добавить раздел хранилища entity.section.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.section.add` добавляет раздел в хранилище данных приложения.", "operationId": "entity_section_add", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/sections/entity-section-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Идентификатор родительского раздела. ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности раздела:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки раздела ||" }, "CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание раздела ||" }, "PICTURE": { "type": "string", "description": "| Картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля раздела `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Идентификатор родительского раздела. ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности раздела:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки раздела ||" }, "CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание раздела ||" }, "PICTURE": { "type": "string", "description": "| Картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля раздела `UF_*`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.delete": { "post": { "summary": "Удалить раздел хранилища entity.section.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.section.delete` удаляет раздел хранилища данных приложения.", "operationId": "entity_section_delete", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/sections/entity-section-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.get": { "post": { "summary": "Получить список разделов хранилища entity.section.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.section.get` получает список разделов хранилища данных приложения.", "operationId": "entity_section_get", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/sections/entity-section-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Объект формата:" }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Объект формата:" }, "FILTER": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.update": { "post": { "summary": "Обновить раздел хранилища entity.section.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.section.update` обновляет раздел хранилища данных приложения.", "operationId": "entity_section_update", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/sections/entity-section-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Идентификатор родительского раздела ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности раздела:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки раздела ||" }, "CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание раздела ||" }, "PICTURE": { "type": "string", "description": "| Картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля раздела `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Идентификатор родительского раздела ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности раздела:" }, "SORT": { "type": "integer", "description": "| Индекс сортировки раздела ||" }, "CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание раздела ||" }, "PICTURE": { "type": "string", "description": "| Картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Детальная картинка раздела. Формат файла — в статье Как загрузить файлы ||" }, "UF_": { "type": "string", "description": "| Пользовательские поля раздела `UF_*`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.update": { "post": { "summary": "Изменить параметры хранилища entity.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `entity.update` обновляет параметры хранилища данных приложения.", "operationId": "entity_update", "tags": [ "Хранилище данных" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_NEW": { "type": "string", "description": "| Новый идентификатор хранилища." }, "ACCESS": { "type": "object", "description": "| Новый набор прав в формате `{\"код_доступа\":\"уровень_права\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_NEW": { "type": "string", "description": "| Новый идентификатор хранилища." }, "ACCESS": { "type": "object", "description": "| Новый набор прав в формате `{\"код_доступа\":\"уровень_права\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/event.bind": { "post": { "summary": "Зарегистрировать новый обработчик события event.bind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.bind` регистрирует новый обработчик события.", "operationId": "event_bind", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-bind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Код события, например `ONCRMLEADADD`. Событие должно входить в scope приложения или быть базовым, иначе метод вернет ошибку `ERROR_EVENT_NOT_FOUND`. Список доступных событий возвращает метод events ||" }, "handler": { "type": "string", "description": "| URL обработчика со схемой `http` или `https`. В имени хоста должна быть точка, поэтому адрес `localhost` не подходит. Обязателен для онлайн-событий, при `event_type=offline` значение игнорируется ||" }, "auth_type": { "type": "integer", "description": "| Идентификатор пользователя, под которым авторизуется обработчик события. По умолчанию для администратора — пользователь, действие которого вызвало событие; для пользователя без прав администратора — он сам. При `event_type=offline` параметр не учитывается ||" }, "event_type": { "type": "string", "description": "| Тип подписки: `online` или `offline`. По умолчанию `online`. При `offline` событие попадает в очередь офлайн-событий ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника для офлайн-событий. С этим ключом создается отдельная очередь, в которую не попадают изменения из запросов самого приложения с тем же `auth_connector`. То же значение передают в методы `event.offline.*`. Параметр доступен не на всех тарифах: проверьте его методом feature.get с ко..." }, "options": { "type": "object", "description": "| Дополнительные настройки регистрируемого события. Набор полей зависит от события." } }, "required": [ "event", "handler" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Код события, например `ONCRMLEADADD`. Событие должно входить в scope приложения или быть базовым, иначе метод вернет ошибку `ERROR_EVENT_NOT_FOUND`. Список доступных событий возвращает метод events ||" }, "handler": { "type": "string", "description": "| URL обработчика со схемой `http` или `https`. В имени хоста должна быть точка, поэтому адрес `localhost` не подходит. Обязателен для онлайн-событий, при `event_type=offline` значение игнорируется ||" }, "auth_type": { "type": "integer", "description": "| Идентификатор пользователя, под которым авторизуется обработчик события. По умолчанию для администратора — пользователь, действие которого вызвало событие; для пользователя без прав администратора — он сам. При `event_type=offline` параметр не учитывается ||" }, "event_type": { "type": "string", "description": "| Тип подписки: `online` или `offline`. По умолчанию `online`. При `offline` событие попадает в очередь офлайн-событий ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника для офлайн-событий. С этим ключом создается отдельная очередь, в которую не попадают изменения из запросов самого приложения с тем же `auth_connector`. То же значение передают в методы `event.offline.*`. Параметр доступен не на всех тарифах: проверьте его методом feature.get с ко..." }, "options": { "type": "object", "description": "| Дополнительные настройки регистрируемого события. Набор полей зависит от события." } }, "required": [ "event", "handler" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.get": { "post": { "summary": "Получить список зарегистрированных обработчиков событий event.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.get` возвращает список обработчиков событий, которые приложение зарегистрировало методом [event.bind](./event-bind.md).", "operationId": "event_get", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.offline.clear": { "post": { "summary": "Очистить записи в очереди офлайн-событий event.offline.clear", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.offline.clear` удаляет из очереди записи пакета, полученного методом [event.offline.get](./event-offline-get.md) с `clear=0`. Так приложение подтверждает, что обработало эти записи. Записи, которые не удалось обработать, пометьте методом [event.offline.error](./event-offline-error.md). Порядок работы с пакетами описан в статье [{#T}](./offline-events.md).", "operationId": "event_offline_clear", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-offline-clear.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром `clear=0`. Значение также есть в поле `PROCESS_ID` записей, которые возвращает метод event.offline.list. Не передавайте пустую строку: метод не вернет ошибку и удалит из очереди все з..." }, "id": { "type": "array", "items": {}, "description": "| Массив значений поля `ID` записей, которые нужно удалить, — целые числа больше `0`. Игнорируется, если передан параметр `message_id`. По умолчанию и при пустом массиве удаляются все записи пакета `process_id` ||" }, "message_id": { "type": "array", "items": {}, "description": "| Массив значений поля `MESSAGE_ID` записей, которые нужно удалить, — строки из 32 символов. По умолчанию и при пустом массиве удаляются все записи пакета `process_id` ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение, с которым пакет получен методом `event.offline.get`, иначе метод ничего не удалит. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" } }, "required": [ "process_id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром `clear=0`. Значение также есть в поле `PROCESS_ID` записей, которые возвращает метод event.offline.list. Не передавайте пустую строку: метод не вернет ошибку и удалит из очереди все з..." }, "id": { "type": "array", "items": {}, "description": "| Массив значений поля `ID` записей, которые нужно удалить, — целые числа больше `0`. Игнорируется, если передан параметр `message_id`. По умолчанию и при пустом массиве удаляются все записи пакета `process_id` ||" }, "message_id": { "type": "array", "items": {}, "description": "| Массив значений поля `MESSAGE_ID` записей, которые нужно удалить, — строки из 32 символов. По умолчанию и при пустом массиве удаляются все записи пакета `process_id` ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение, с которым пакет получен методом `event.offline.get`, иначе метод ничего не удалит. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" } }, "required": [ "process_id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.offline.error": { "post": { "summary": "Зарегистрировать ошибки обработки очереди офлайн-событий event.offline.error", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.offline.error` помечает записи зарезервированного пакета [офлайн-событий](./offline-events.md) как ошибочные. Такие записи снимаются с резерва и больше не попадают в обычную выдачу [event.offline.get](./event-offline-get.md). Получить их можно методом `event.offline.get` с параметром `error=1`.", "operationId": "event_offline_error", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-offline-error.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром `clear=0` ||" }, "message_id": { "type": "array", "items": {}, "description": "| Массив значений поля `MESSAGE_ID` из ответа `event.offline.get` — ключи записей, которые нужно пометить ошибочными. Ключ — строка из 32 символов. Длину метод не проверяет: с неверным ключом запись не найдется, ошибки не будет. Записи, уже помеченные ошибочными, метод не изменяет. Если передать ..." }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение, с которым пакет получен методом `event.offline.get`, иначе метод не найдет записи. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" } }, "required": [ "process_id", "message_id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Идентификатор зарезервированного пакета событий. Его возвращает метод event.offline.get при вызове с параметром `clear=0` ||" }, "message_id": { "type": "array", "items": {}, "description": "| Массив значений поля `MESSAGE_ID` из ответа `event.offline.get` — ключи записей, которые нужно пометить ошибочными. Ключ — строка из 32 символов. Длину метод не проверяет: с неверным ключом запись не найдется, ошибки не будет. Записи, уже помеченные ошибочными, метод не изменяет. Если передать ..." }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение, с которым пакет получен методом `event.offline.get`, иначе метод не найдет записи. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" } }, "required": [ "process_id", "message_id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.offline.get": { "post": { "summary": "Получить список офлайн-событий с «очисткой» event.offline.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.offline.get` возвращает приложению первые записи из очереди [офлайн-событий](./offline-events.md), подходящие под фильтр. У метода два режима:", "operationId": "event_offline_get", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-offline-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр записей. По умолчанию метод возвращает все записи. Фильтровать можно по полям: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`." }, "order": { "type": "object", "description": "| Сортировка записей по тем же полям, что и в фильтре, в виде `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`. По умолчанию — `{\"TIMESTAMP_X\": \"ASC\"}` ||" }, "limit": { "type": "integer", "description": "| Количество выбираемых записей, целое число больше `0`. По умолчанию 50 ||" }, "clear": { "type": "integer", "description": "| Удалять ли выбранные записи: `1` — удалить сразу, `0` — зарезервировать пакетом. По умолчанию `1`. Значение `0` без режима `rest_offline_extended` вернет ошибку `WRONG_LICENSE` ||" }, "process_id": { "type": "string", "description": "| Идентификатор ранее зарезервированного пакета. Передайте его, чтобы повторно получить записи пакета, которые еще не подтверждены. С `clear=1` метод удалит весь пакет, включая записи, которые не вошли в ответ из-за `limit`. Чтобы оставить записи, передайте `clear=0` ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение `auth_connector`, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" }, "error": { "type": "integer", "description": "| `1` — вернуть только записи, помеченные ошибочными методом event.offline.error, `0` — только записи без такой пометки. По умолчанию `0` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр записей. По умолчанию метод возвращает все записи. Фильтровать можно по полям: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`." }, "order": { "type": "object", "description": "| Сортировка записей по тем же полям, что и в фильтре, в виде `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`. По умолчанию — `{\"TIMESTAMP_X\": \"ASC\"}` ||" }, "limit": { "type": "integer", "description": "| Количество выбираемых записей, целое число больше `0`. По умолчанию 50 ||" }, "clear": { "type": "integer", "description": "| Удалять ли выбранные записи: `1` — удалить сразу, `0` — зарезервировать пакетом. По умолчанию `1`. Значение `0` без режима `rest_offline_extended` вернет ошибку `WRONG_LICENSE` ||" }, "process_id": { "type": "string", "description": "| Идентификатор ранее зарезервированного пакета. Передайте его, чтобы повторно получить записи пакета, которые еще не подтверждены. С `clear=1` метод удалит весь пакет, включая записи, которые не вошли в ответ из-за `limit`. Чтобы оставить записи, передайте `clear=0` ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Передайте то же значение `auth_connector`, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector`, иначе метод вернет ошибку `WRONG_LICENSE` ||" }, "error": { "type": "integer", "description": "| `1` — вернуть только записи, помеченные ошибочными методом event.offline.error, `0` — только записи без такой пометки. По умолчанию `0` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.offline.list": { "post": { "summary": "Получить список офлайн-событий event.offline.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.offline.list` читает очередь [офлайн-событий](./offline-events.md) приложения, которое его вызвало. В отличие от [event.offline.get](./event-offline-get.md), он не резервирует записи и не выдает `process_id`. Чтобы подтвердить или пометить записи ошибочными, получите их методом `event.offline.get` с `clear=0`.", "operationId": "event_offline_list", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-offline-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр записей. Без фильтра метод возвращает все записи. Фильтровать можно по полям: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`, `PROCESS_ID`, `ERROR`." }, "order": { "type": "object", "description": "| Сортировка записей по тем же полям, что и в фильтре, в виде `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`. По умолчанию — `{\"ID\": \"ASC\"}` ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "auth_connector": { "type": "string", "description": "| Ключ источника. Очередь офлайн-событий разделена по источникам. Передайте то же значение `auth_connector`, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector..." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Фильтр записей. Без фильтра метод возвращает все записи. Фильтровать можно по полям: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`, `PROCESS_ID`, `ERROR`." }, "order": { "type": "object", "description": "| Сортировка записей по тем же полям, что и в фильтре, в виде `{\"поле\": \"ASC\"}` или `{\"поле\": \"DESC\"}`. По умолчанию — `{\"ID\": \"ASC\"}` ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "auth_connector": { "type": "string", "description": "| Ключ источника. Очередь офлайн-событий разделена по источникам. Передайте то же значение `auth_connector`, что и при подписке методом event.bind, иначе метод вернет только события без источника. Параметр доступен не на всех тарифах: проверьте его методом feature.get с кодом `rest_auth_connector..." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/event.unbind": { "post": { "summary": "Отменить зарегистрированный обработчик события event.unbind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `event.unbind` удаляет обработчики события, зарегистрированные приложением методом [event.bind](./event-bind.md). В BX24.js для метода есть обертка [BX24.callUnbind](../../sdk/bx24-js-sdk/how-to-call-rest-methods/bx24-call-unbind.md).", "operationId": "event_unbind", "tags": [ "События" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/events/event-unbind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Код события, например `ONCRMLEADADD`. Регистр не важен ||" }, "handler": { "type": "string", "description": "| URL обработчика, указанный при регистрации. Обязателен для онлайн-событий. При `event_type=offline` значение игнорируется ||" }, "auth_type": { "type": "integer", "description": "| Идентификатор пользователя, под которым авторизуется обработчик события. Без параметра администратор удаляет обработчики всех пользователей, а пользователь без прав администратора — только свои. Пользователю без прав администратора параметр передавать не нужно: если он передан, допустим только ..." }, "event_type": { "type": "string", "description": "| Тип подписки: `online` или `offline`, регистр не важен. По умолчанию `online`. При `offline` метод работает с офлайн-событиями ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Учитывается только при `event_type=offline`: удаляются офлайн-обработчики с тем же `auth_connector`, что передан в event.bind. Без параметра удаляются обработчики без ключа источника ||" } }, "required": [ "event", "handler" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Код события, например `ONCRMLEADADD`. Регистр не важен ||" }, "handler": { "type": "string", "description": "| URL обработчика, указанный при регистрации. Обязателен для онлайн-событий. При `event_type=offline` значение игнорируется ||" }, "auth_type": { "type": "integer", "description": "| Идентификатор пользователя, под которым авторизуется обработчик события. Без параметра администратор удаляет обработчики всех пользователей, а пользователь без прав администратора — только свои. Пользователю без прав администратора параметр передавать не нужно: если он передан, допустим только ..." }, "event_type": { "type": "string", "description": "| Тип подписки: `online` или `offline`, регистр не важен. По умолчанию `online`. При `offline` метод работает с офлайн-событиями ||" }, "auth_connector": { "type": "string", "description": "| Ключ источника. Учитывается только при `event_type=offline`: удаляются офлайн-обработчики с тем же `auth_connector`, что передан в event.bind. Без параметра удаляются обработчики без ключа источника ||" } }, "required": [ "event", "handler" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/feature.access": { "post": { "summary": "Проверить права текущего пользователя sonet_group.feature.access", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.feature.access` проверяет, доступна ли текущему пользователю операция в функционале группы или проекта.", "operationId": "feature_access", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/sonet-group-feature-access.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор группы или проекта." }, "FEATURE": { "type": "string", "description": "| Символьный код функционала группы." }, "OPERATION": { "type": "string", "description": "| Символьный код операции внутри функционала." } }, "required": [ "GROUP_ID", "FEATURE", "OPERATION" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор группы или проекта." }, "FEATURE": { "type": "string", "description": "| Символьный код функционала группы." }, "OPERATION": { "type": "string", "description": "| Символьный код операции внутри функционала." } }, "required": [ "GROUP_ID", "FEATURE", "OPERATION" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/feature.get": { "post": { "summary": "Получить информацию о доступности возможности в Битрикс24 feature.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `feature.get` проверяет, доступна ли возможность REST API в конкретном Битрикс24. Доступность зависит от тарифа, поэтому проверяйте ее перед использованием возможности в приложении.", "operationId": "feature_get", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/system/feature-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код возможности. Доступные коды:" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код возможности. Доступные коды:" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/field.custom.add": { "post": { "summary": "Создать пользовательское поле v 3.0 crm.<тип>.field.custom.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с настройками нового поля в формате `{\"параметр\": \"значение\"}`. В нем обязательны `name` и `userTypeId`. Описание параметра ||" }, "userTypeId": { "type": "string", "description": "| Тип поля. Возможные значения." }, "xmlId": { "type": "string", "description": "| Внешний код поля, например идентификатор поля во внешней системе ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки поля в списке полей." }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показывать ли поле в фильтре списка элементов и как искать по нему." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке элементов." }, "editInList": { "type": "boolean", "description": "| Разрешено ли менять значение поля в списке элементов." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки, которые зависят от типа поля, например значение по умолчанию или инфоблок для привязки. Описание параметра ||" }, "editFormLabel": { "type": "string", "description": "\\| `object` | Название поля в карточке элемента. Как передать подписи ||" }, "listColumnLabel": { "type": "string", "description": "\\| `object` | Заголовок колонки поля в списке элементов ||" }, "listFilterLabel": { "type": "string", "description": "\\| `object` | Подпись поля в фильтре ||" }, "errorMessage": { "type": "string", "description": "\\| `object` | Текст ошибки, которую видит пользователь при неверном значении ||" }, "helpMessage": { "type": "string", "description": "\\| `object` | Текст подсказки к полю ||" } }, "required": [ "fields", "userTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с настройками нового поля в формате `{\"параметр\": \"значение\"}`. В нем обязательны `name` и `userTypeId`. Описание параметра ||" }, "userTypeId": { "type": "string", "description": "| Тип поля. Возможные значения." }, "xmlId": { "type": "string", "description": "| Внешний код поля, например идентификатор поля во внешней системе ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки поля в списке полей." }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показывать ли поле в фильтре списка элементов и как искать по нему." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке элементов." }, "editInList": { "type": "boolean", "description": "| Разрешено ли менять значение поля в списке элементов." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки, которые зависят от типа поля, например значение по умолчанию или инфоблок для привязки. Описание параметра ||" }, "editFormLabel": { "type": "string", "description": "\\| `object` | Название поля в карточке элемента. Как передать подписи ||" }, "listColumnLabel": { "type": "string", "description": "\\| `object` | Заголовок колонки поля в списке элементов ||" }, "listFilterLabel": { "type": "string", "description": "\\| `object` | Подпись поля в фильтре ||" }, "errorMessage": { "type": "string", "description": "\\| `object` | Текст ошибки, которую видит пользователь при неверном значении ||" }, "helpMessage": { "type": "string", "description": "\\| `object` | Текст подсказки к полю ||" } }, "required": [ "fields", "userTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.delete": { "post": { "summary": "Удалить пользовательское поле v 3.0 crm.<тип>.field.custom.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.enum.add": { "post": { "summary": "Добавить вариант в поле-список v 3.0 crm.<тип>.field.custom.enum.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_enum_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-enum-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными варианта в формате `{\"параметр\": \"значение\"}`. Обязательные поля — `fieldId` и `value`. Описание параметра ||" }, "fieldId": { "type": "integer", "description": "\\| `string` | Идентификатор поля-списка или его имя, например `6008205` или `\"UF_CRM_19_PRIORITY\"`. Идентификатор и имя поля возвращает метод crm.<тип>.field.custom.list ||" }, "value": { "type": "string", "description": "| Текст варианта, который видит пользователь, например `Срочный`. Пустую строку метод не принимает ||" }, "isDefault": { "type": "boolean", "description": "| Выбран ли вариант по умолчанию у новых элементов." }, "sort": { "type": "integer", "description": "| Порядок варианта в списке." }, "xmlId": { "type": "string", "description": "| Внешний код варианта, уникальный в пределах поля. Если код не передан, Битрикс24 создаст его сам, например `crm_rest_enum_geu7u4uivzmoxv0ytjmransvcbi44rxq` ||" } }, "required": [ "fields", "fieldId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными варианта в формате `{\"параметр\": \"значение\"}`. Обязательные поля — `fieldId` и `value`. Описание параметра ||" }, "fieldId": { "type": "integer", "description": "\\| `string` | Идентификатор поля-списка или его имя, например `6008205` или `\"UF_CRM_19_PRIORITY\"`. Идентификатор и имя поля возвращает метод crm.<тип>.field.custom.list ||" }, "value": { "type": "string", "description": "| Текст варианта, который видит пользователь, например `Срочный`. Пустую строку метод не принимает ||" }, "isDefault": { "type": "boolean", "description": "| Выбран ли вариант по умолчанию у новых элементов." }, "sort": { "type": "integer", "description": "| Порядок варианта в списке." }, "xmlId": { "type": "string", "description": "| Внешний код варианта, уникальный в пределах поля. Если код не передан, Битрикс24 создаст его сам, например `crm_rest_enum_geu7u4uivzmoxv0ytjmransvcbi44rxq` ||" } }, "required": [ "fields", "fieldId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.enum.delete": { "post": { "summary": "Удалить вариант поля-списка v 3.0 crm.<тип>.field.custom.enum.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_enum_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-enum-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.enum.get": { "post": { "summary": "Получить вариант поля-списка v 3.0 crm.<тип>.field.custom.enum.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_enum_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-enum-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей варианта, которые нужно вернуть, например `[\"value\", \"sort\"]`. Поля варианта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей варианта, которые нужно вернуть, например `[\"value\", \"sort\"]`. Поля варианта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.enum.list": { "post": { "summary": "Получить варианты поля-списка v 3.0 crm.<тип>.field.custom.enum.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_enum_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-enum-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по полю-списку. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей варианта, которые нужно вернуть, например `[\"id\", \"value\"]`. Поля варианта." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"asc\"}` или `{\"поле\": \"desc\"}`. Сортировать можно по `id` и `sort` ||" }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — сколько вариантов вернуть, `offset` — сколько пропустить ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по полю-списку. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей варианта, которые нужно вернуть, например `[\"id\", \"value\"]`. Поля варианта." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"asc\"}` или `{\"поле\": \"desc\"}`. Сортировать можно по `id` и `sort` ||" }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — сколько вариантов вернуть, `offset` — сколько пропустить ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.enum.update": { "post": { "summary": "Изменить вариант поля-списка v 3.0 crm.<тип>.field.custom.enum.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_enum_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-enum-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" }, "fields": { "type": "object", "description": "| Объект с новыми данными варианта в формате `{\"параметр\": \"значение\"}`. Описание параметра ||" }, "value": { "type": "string", "description": "| Текст варианта, который видит пользователь, например `Срочный`. Пустую строку метод не принимает ||" }, "isDefault": { "type": "boolean", "description": "| Выбран ли вариант по умолчанию у новых элементов." }, "sort": { "type": "integer", "description": "| Порядок варианта в списке ||" }, "xmlId": { "type": "string", "description": "| Внешний код варианта, уникальный в пределах поля ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list ||" }, "fields": { "type": "object", "description": "| Объект с новыми данными варианта в формате `{\"параметр\": \"значение\"}`. Описание параметра ||" }, "value": { "type": "string", "description": "| Текст варианта, который видит пользователь, например `Срочный`. Пустую строку метод не принимает ||" }, "isDefault": { "type": "boolean", "description": "| Выбран ли вариант по умолчанию у новых элементов." }, "sort": { "type": "integer", "description": "| Порядок варианта в списке ||" }, "xmlId": { "type": "string", "description": "| Внешний код варианта, уникальный в пределах поля ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.get": { "post": { "summary": "Получить пользовательское поле v 3.0 crm.<тип>.field.custom.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." }, "select": { "type": "array", "items": {}, "description": "| Список параметров поля, которые нужно вернуть, например `[\"id\", \"name\", \"settings\"]`. Можно передать `id`, `entityId` и параметры из описания параметра fields метода создания." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." }, "select": { "type": "array", "items": {}, "description": "| Список параметров поля, которые нужно вернуть, например `[\"id\", \"name\", \"settings\"]`. Можно передать `id`, `entityId` и параметры из описания параметра fields метода создания." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.list": { "post": { "summary": "Получить список пользовательских полей v 3.0 crm.<тип>.field.custom.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список параметров поля, которые нужно вернуть, например `[\"id\", \"name\", \"userTypeId\"]`. Можно передать `id`, `entityId` и параметры из описания параметра fields метода создания." }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора полей. Описание параметра ||" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"параметр\": \"asc\"}` или `{\"параметр\": \"desc\"}`. Сортировать можно по `id` и `name` ||" }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — сколько полей вернуть, `offset` — сколько пропустить, например `{\"limit\": 20, \"offset\": 40}` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список параметров поля, которые нужно вернуть, например `[\"id\", \"name\", \"userTypeId\"]`. Можно передать `id`, `entityId` и параметры из описания параметра fields метода создания." }, "filter": { "type": "array", "items": {}, "description": "| Условия отбора полей. Описание параметра ||" }, "order": { "type": "object", "description": "| Сортировка в формате `{\"параметр\": \"asc\"}` или `{\"параметр\": \"desc\"}`. Сортировать можно по `id` и `name` ||" }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — сколько полей вернуть, `offset` — сколько пропустить, например `{\"limit\": 20, \"offset\": 40}` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.custom.update": { "post": { "summary": "Изменить пользовательское поле v 3.0 crm.<тип>.field.custom.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_custom_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-custom-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." }, "fields": { "type": "object", "description": "| Объект с новыми настройками поля в формате `{\"параметр\": \"значение\"}`. Описание параметра ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор поля или его имя, например `6008209` или `\"UF_CRM_CONTRACT_NUMBER\"`." }, "fields": { "type": "object", "description": "| Объект с новыми настройками поля в формате `{\"параметр\": \"значение\"}`. Описание параметра ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.get": { "post": { "summary": "Получить описание поля v 3.0 crm.<тип>.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть, например `[\"name\", \"type\", \"editable\"]`. Поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть, например `[\"name\", \"type\", \"editable\"]`. Поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.list": { "post": { "summary": "Получить описание полей v 3.0 crm.<тип>.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть, например `[\"name\", \"type\", \"editable\"]`. Поля описания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть, например `[\"name\", \"type\", \"editable\"]`. Поля описания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.required.clear": { "post": { "summary": "Снять обязательность поля v 3.0 crm.<тип>.field.required.clear", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_required_clear", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-required-clear-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" } }, "required": [ "fieldId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.required.get": { "post": { "summary": "Получить обязательность поля v 3.0 crm.<тип>.field.required.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_required_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-required-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" } }, "required": [ "fieldId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/field.required.set": { "post": { "summary": "Сделать поле обязательным v 3.0 crm.<тип>.field.required.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "field_required_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/fields/crm-entity-field-required-set-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" }, "requiredStageIds": { "type": "string", "description": "| Стадии, на которых поле обязательно, например `[\"DT1038_69:CLIENT\"]`. Как работает параметр ||" } }, "required": [ "fieldId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "| Имя поля: стандартного в camelCase, например `title` или `opportunity`, или пользовательского, например `UF_CRM_CONTRACT_NUMBER`. Имена полей возвращает метод crm.<тип>.field.list ||" }, "categoryId": { "type": "integer", "description": "| Идентификатор воронки. Когда передавать ||" }, "requiredStageIds": { "type": "string", "description": "| Стадии, на которых поле обязательно, например `[\"DT1038_69:CLIENT\"]`. Как работает параметр ||" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/forum.message.delete": { "post": { "summary": "Удалить сообщение форума forum.message.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_delete", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/message/forum-message-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.add": { "post": { "summary": "Добавить пользовательское поле сообщений форума forum.message.field.custom.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_add", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового пользовательского поля. Описание полей ||" }, "userTypeId": { "type": "string", "description": "| Тип поля, например:" }, "xmlId": { "type": "string", "description": "| Внешний код поля ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки." }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показ поля в фильтре списка." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке." }, "editInList": { "type": "boolean", "description": "| Разрешено ли редактировать значение поля." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки типа поля." }, "editFormLabel": { "type": "object", "description": "| Подпись поля в форме редактирования. Передавайте объектом, где ключ — код языка, значение — подпись, например `{\"ru\":\"Внешний код\",\"en\":\"External ID\"}`. Значение строкой не сохраняется ||" }, "listColumnLabel": { "type": "object", "description": "| Заголовок колонки в списке. Формат такой же, как у `editFormLabel` ||" }, "listFilterLabel": { "type": "object", "description": "| Подпись поля в фильтре. Формат такой же, как у `editFormLabel` ||" }, "errorMessage": { "type": "object", "description": "| Текст ошибки при неверном значении поля. Формат такой же, как у `editFormLabel` ||" }, "helpMessage": { "type": "object", "description": "| Текст подсказки к полю. Формат такой же, как у `editFormLabel` ||" } }, "required": [ "fields", "userTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового пользовательского поля. Описание полей ||" }, "userTypeId": { "type": "string", "description": "| Тип поля, например:" }, "xmlId": { "type": "string", "description": "| Внешний код поля ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки." }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показ поля в фильтре списка." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке." }, "editInList": { "type": "boolean", "description": "| Разрешено ли редактировать значение поля." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки типа поля." }, "editFormLabel": { "type": "object", "description": "| Подпись поля в форме редактирования. Передавайте объектом, где ключ — код языка, значение — подпись, например `{\"ru\":\"Внешний код\",\"en\":\"External ID\"}`. Значение строкой не сохраняется ||" }, "listColumnLabel": { "type": "object", "description": "| Заголовок колонки в списке. Формат такой же, как у `editFormLabel` ||" }, "listFilterLabel": { "type": "object", "description": "| Подпись поля в фильтре. Формат такой же, как у `editFormLabel` ||" }, "errorMessage": { "type": "object", "description": "| Текст ошибки при неверном значении поля. Формат такой же, как у `editFormLabel` ||" }, "helpMessage": { "type": "object", "description": "| Текст подсказки к полю. Формат такой же, как у `editFormLabel` ||" } }, "required": [ "fields", "userTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.delete": { "post": { "summary": "Удалить пользовательское поле сообщений форума forum.message.field.custom.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_delete", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, которое нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля, которое нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.enum.add": { "post": { "summary": "Добавить значение списка в пользовательское поле forum.message.field.custom.enum.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_enum_add", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-enum-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового значения списка. Описание полей ||" }, "fieldId": { "type": "integer", "description": "| Идентификатор пользовательского поля, в которое нужно добавить значение. Поле должно иметь тип `enumeration`." }, "value": { "type": "string", "description": "| Текст значения, который видит пользователь." }, "sort": { "type": "integer", "description": "| Порядок сортировки значения в списке." }, "xmlId": { "type": "string", "description": "| Внешний код значения. Должен быть уникальным в пределах поля: повторный код вызывает внутреннюю ошибку с HTTP-статусом 500." }, "isDefault": { "type": "boolean", "description": "| Признак значения по умолчанию." } }, "required": [ "fields", "fieldId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового значения списка. Описание полей ||" }, "fieldId": { "type": "integer", "description": "| Идентификатор пользовательского поля, в которое нужно добавить значение. Поле должно иметь тип `enumeration`." }, "value": { "type": "string", "description": "| Текст значения, который видит пользователь." }, "sort": { "type": "integer", "description": "| Порядок сортировки значения в списке." }, "xmlId": { "type": "string", "description": "| Внешний код значения. Должен быть уникальным в пределах поля: повторный код вызывает внутреннюю ошибку с HTTP-статусом 500." }, "isDefault": { "type": "boolean", "description": "| Признак значения по умолчанию." } }, "required": [ "fields", "fieldId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.enum.delete": { "post": { "summary": "Удалить значение списка пользовательского поля forum.message.field.custom.enum.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_enum_delete", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-enum-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка, которое нужно удалить." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка, которое нужно удалить." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.enum.get": { "post": { "summary": "Получить значение списка пользовательского поля forum.message.field.custom.enum.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_enum_get", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-enum-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка." }, "select": { "type": "array", "items": {}, "description": "| Массив полей значения, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка." }, "select": { "type": "array", "items": {}, "description": "| Массив полей значения, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.enum.list": { "post": { "summary": "Получить значения списка пользовательского поля forum.message.field.custom.enum.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_enum_list", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-enum-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Идентификатор пользовательского поля, значения которого нужно получить. Передайте одно условие в формате `[\"fieldId\", идентификатор]`, например `[\"fieldId\", 6008093]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей значения, которые нужно вернуть в ответе." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Идентификатор пользовательского поля, значения которого нужно получить. Передайте одно условие в формате `[\"fieldId\", идентификатор]`, например `[\"fieldId\", 6008093]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей значения, которые нужно вернуть в ответе." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.enum.update": { "post": { "summary": "Изменить значение списка пользовательского поля forum.message.field.custom.enum.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_enum_update", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-enum-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка, которое нужно изменить." }, "fields": { "type": "object", "description": "| Объект с полями значения, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "value": { "type": "string", "description": "| Новый текст значения. Пустая строка удаляет значение из списка ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки значения в списке ||" }, "xmlId": { "type": "string", "description": "| Внешний код значения. Должен быть уникальным в пределах поля ||" }, "isDefault": { "type": "boolean", "description": "| Признак значения по умолчанию." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор значения списка, которое нужно изменить." }, "fields": { "type": "object", "description": "| Объект с полями значения, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "value": { "type": "string", "description": "| Новый текст значения. Пустая строка удаляет значение из списка ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки значения в списке ||" }, "xmlId": { "type": "string", "description": "| Внешний код значения. Должен быть уникальным в пределах поля ||" }, "isDefault": { "type": "boolean", "description": "| Признак значения по умолчанию." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.get": { "post": { "summary": "Получить пользовательское поле сообщений форума forum.message.field.custom.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_get", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.list": { "post": { "summary": "Получить список пользовательских полей сообщений форума forum.message.field.custom.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_list", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/forum.message.field.custom.update": { "post": { "summary": "Изменить пользовательское поле сообщений форума forum.message.field.custom.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "forum_message_field_custom_update", "tags": [ "forum" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/forum/userfield/forum-message-field-custom-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект с полями пользовательского поля, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "xmlId": { "type": "string", "description": "| Внешний код поля ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки ||" }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показ поля в фильтре списка." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке." }, "editInList": { "type": "boolean", "description": "| Разрешено ли редактировать значение поля." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки типа поля." }, "editFormLabel": { "type": "object", "description": "| Подпись поля в форме редактирования. Передавайте объектом, где ключ — код языка, значение — подпись, например `{\"ru\":\"Код во внешней системе\",\"en\":\"External system code\"}`. Значение строкой не сохраняется ||" }, "listColumnLabel": { "type": "object", "description": "| Заголовок колонки в списке. Формат такой же, как у `editFormLabel` ||" }, "listFilterLabel": { "type": "object", "description": "| Подпись поля в фильтре. Формат такой же, как у `editFormLabel` ||" }, "errorMessage": { "type": "object", "description": "| Текст ошибки при неверном значении поля. Формат такой же, как у `editFormLabel` ||" }, "helpMessage": { "type": "object", "description": "| Текст подсказки к полю. Формат такой же, как у `editFormLabel` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Объект с полями пользовательского поля, которые нужно изменить. Передавайте только изменяемые поля. Описание полей" }, "xmlId": { "type": "string", "description": "| Внешний код поля ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки ||" }, "isMultiple": { "type": "boolean", "description": "| Признак множественного поля." }, "isMandatory": { "type": "boolean", "description": "| Признак обязательного поля." }, "showFilter": { "type": "string", "description": "| Показ поля в фильтре списка." }, "showInList": { "type": "boolean", "description": "| Показывать ли поле в списке." }, "editInList": { "type": "boolean", "description": "| Разрешено ли редактировать значение поля." }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске." }, "settings": { "type": "object", "description": "| Настройки типа поля." }, "editFormLabel": { "type": "object", "description": "| Подпись поля в форме редактирования. Передавайте объектом, где ключ — код языка, значение — подпись, например `{\"ru\":\"Код во внешней системе\",\"en\":\"External system code\"}`. Значение строкой не сохраняется ||" }, "listColumnLabel": { "type": "object", "description": "| Заголовок колонки в списке. Формат такой же, как у `editFormLabel` ||" }, "listFilterLabel": { "type": "object", "description": "| Подпись поля в фильтре. Формат такой же, как у `editFormLabel` ||" }, "errorMessage": { "type": "object", "description": "| Текст ошибки при неверном значении поля. Формат такой же, как у `editFormLabel` ||" }, "helpMessage": { "type": "object", "description": "| Текст подсказки к полю. Формат такой же, как у `editFormLabel` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "forum" ] } ] } }, "/humanresources.employee.count": { "post": { "summary": "Получить количество сотрудников humanresources.employee.count", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_count", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-count.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.employee.field.get": { "post": { "summary": "Получить поле сотрудника humanresources.employee.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_field_get", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Какие свойства описания поля вернуть в ответе. Если `select` не передан, метод вернет все свойства." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Какие свойства описания поля вернуть в ответе. Если `select` не передан, метод вернет все свойства." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.employee.field.list": { "post": { "summary": "Получить список полей сотрудника humanresources.employee.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_field_list", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Какие свойства описания поля вернуть в ответе. Если `select` не передан, метод вернет все свойства." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Какие свойства описания поля вернуть в ответе. Если `select` не передан, метод вернет все свойства." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.employee.multidepartment": { "post": { "summary": "Получить сотрудников в нескольких отделах humanresources.employee.multidepartment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_multidepartment", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-multidepartment.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.employee.search": { "post": { "summary": "Найти сотрудников humanresources.employee.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_search", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды, в которых нужно искать." }, "select": { "type": "array", "items": {}, "description": "| Список полей сотрудника. Метод проверяет имена полей и на неизвестное поле отвечает ошибкой. В ответе всегда возвращаются все поля сотрудника." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды, в которых нужно искать." }, "select": { "type": "array", "items": {}, "description": "| Список полей сотрудника. Метод проверяет имена полей и на неизвестное поле отвечает ошибкой. В ответе всегда возвращаются все поля сотрудника." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.employee.subordinates": { "post": { "summary": "Получить количество подчиненных сотрудника по отделам humanresources.employee.subordinates", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_employee_subordinates", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/employee/humanresources-employee-subordinates.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользователя, чьих подчиненных нужно посчитать." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользователя, чьих подчиненных нужно посчитать." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.hcmlink.company.add": { "post": { "summary": "Добавить компанию HCM Link humanresources.hcmlink.company.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.company.add` добавляет компанию из системы кадрового учета в интеграцию HCM Link.", "operationId": "humanresources_hcmlink_company_add", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-company-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Данные компании из системы кадрового учета (подробное описание) ||" }, "company": { "type": "string", "description": "| Код компании в системе кадрового учета ||" }, "crmCompanyId": { "type": "integer", "description": "| Идентификатор компании CRM." }, "title": { "type": "string", "description": "| Название компании ||" }, "data": { "type": "object", "description": "| Дополнительные данные компании ||" }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета ||" }, "type": { "type": "string", "description": "| Тип поля. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "entityType": { "type": "string", "description": "| Тип объекта, к которому относится поле. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "ttl": { "type": "integer", "description": "| Время хранения значения поля в секундах." } }, "required": [ "fields", "company", "crmCompanyId", "title", "field" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Данные компании из системы кадрового учета (подробное описание) ||" }, "company": { "type": "string", "description": "| Код компании в системе кадрового учета ||" }, "crmCompanyId": { "type": "integer", "description": "| Идентификатор компании CRM." }, "title": { "type": "string", "description": "| Название компании ||" }, "data": { "type": "object", "description": "| Дополнительные данные компании ||" }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета ||" }, "type": { "type": "string", "description": "| Тип поля. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "entityType": { "type": "string", "description": "| Тип объекта, к которому относится поле. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "ttl": { "type": "integer", "description": "| Время хранения значения поля в секундах." } }, "required": [ "fields", "company", "crmCompanyId", "title", "field" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.company.delete": { "post": { "summary": "Удалить компанию HCM Link humanresources.hcmlink.company.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.company.delete` удаляет компанию из интеграции HCM Link.", "operationId": "humanresources_hcmlink_company_delete", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-company-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании HCM Link." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании HCM Link." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.company.list": { "post": { "summary": "Получить список компаний HCM Link humanresources.hcmlink.company.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.company.list` возвращает список компаний, подключенных к интеграции HCM Link.", "operationId": "humanresources_hcmlink_company_list", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-company-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24. Если передан, метод вернет компании, связанные с этим пользователем ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24. Если передан, метод вернет компании, связанные с этим пользователем ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.company.update": { "post": { "summary": "Обновить компанию HCM Link humanresources.hcmlink.company.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.company.update` обновляет компанию из системы кадрового учета и список ее полей в интеграции HCM Link.", "operationId": "humanresources_hcmlink_company_update", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-company-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании HCM Link." }, "fields": { "type": "object", "description": "| Новые данные компании из системы кадрового учета (подробное описание) ||" }, "company": { "type": "string", "description": "| Код компании в системе кадрового учета ||" }, "crmCompanyId": { "type": "integer", "description": "| Идентификатор компании CRM." }, "title": { "type": "string", "description": "| Название компании ||" }, "data": { "type": "object", "description": "| Дополнительные данные компании ||" }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета ||" }, "type": { "type": "string", "description": "| Тип поля. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "entityType": { "type": "string", "description": "| Тип объекта, к которому относится поле. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "ttl": { "type": "integer", "description": "| Время хранения значения поля в секундах." } }, "required": [ "id", "fields", "company", "crmCompanyId", "title", "field" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор компании HCM Link." }, "fields": { "type": "object", "description": "| Новые данные компании из системы кадрового учета (подробное описание) ||" }, "company": { "type": "string", "description": "| Код компании в системе кадрового учета ||" }, "crmCompanyId": { "type": "integer", "description": "| Идентификатор компании CRM." }, "title": { "type": "string", "description": "| Название компании ||" }, "data": { "type": "object", "description": "| Дополнительные данные компании ||" }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета ||" }, "type": { "type": "string", "description": "| Тип поля. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "entityType": { "type": "string", "description": "| Тип объекта, к которому относится поле. Если не передать значение, метод сохранит поле с внутренним типом `UNKNOWN`." }, "ttl": { "type": "integer", "description": "| Время хранения значения поля в секундах." } }, "required": [ "id", "fields", "company", "crmCompanyId", "title", "field" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.company.user.list": { "post": { "summary": "Получить список компаний HCM Link текущего пользователя humanresources.hcmlink.company.user.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.company.user.list` возвращает компании из системы кадрового учета, связанные с текущим пользователем Битрикс24.", "operationId": "humanresources_hcmlink_company_user_list", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-company-user-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.employee.list": { "post": { "summary": "Получить список сопоставленных сотрудников HCM Link humanresources.hcmlink.employee.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.employee.list` возвращает список сопоставленных сотрудников системы кадрового учета и Битрикс24.", "operationId": "humanresources_hcmlink_employee_list", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-employee-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета." }, "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "updatedAt": { "type": "string", "description": "| Дата изменения в формате ISO 8601. Если передана, метод вернет записи, измененные после этой даты ||" } }, "required": [ "company" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета." }, "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Смещение для постраничной навигации." }, "updatedAt": { "type": "string", "description": "| Дата изменения в формате ISO 8601. Если передана, метод вернет записи, измененные после этой даты ||" } }, "required": [ "company" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.employee.set": { "post": { "summary": "Передать список сотрудников HCM Link humanresources.hcmlink.employee.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.employee.set` передает список сотрудников из системы кадрового учета в интеграцию HCM Link.", "operationId": "humanresources_hcmlink_employee_set", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-employee-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета." }, "data": { "type": "array", "items": {}, "description": "| Список сотрудников из системы кадрового учета (подробное описание) ||" }, "job": { "type": "object", "description": "| Данные для обновления задания синхронизации (подробное описание)." }, "employee": { "type": "string", "description": "| Код сотрудника в системе кадрового учета ||" }, "person": { "type": "string", "description": "| Код физического лица в системе кадрового учета ||" }, "userId": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24." }, "firstName": { "type": "string", "description": "| Имя ||" }, "lastName": { "type": "string", "description": "| Фамилия ||" }, "patronymicName": { "type": "string", "description": "| Отчество ||" }, "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Новые данные задания синхронизации (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" } }, "required": [ "company", "data", "employee", "person", "id", "fields", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета." }, "data": { "type": "array", "items": {}, "description": "| Список сотрудников из системы кадрового учета (подробное описание) ||" }, "job": { "type": "object", "description": "| Данные для обновления задания синхронизации (подробное описание)." }, "employee": { "type": "string", "description": "| Код сотрудника в системе кадрового учета ||" }, "person": { "type": "string", "description": "| Код физического лица в системе кадрового учета ||" }, "userId": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24." }, "firstName": { "type": "string", "description": "| Имя ||" }, "lastName": { "type": "string", "description": "| Фамилия ||" }, "patronymicName": { "type": "string", "description": "| Отчество ||" }, "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Новые данные задания синхронизации (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" } }, "required": [ "company", "data", "employee", "person", "id", "fields", "status" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.field.value.set": { "post": { "summary": "Передать значения полей HCM Link humanresources.hcmlink.field.value.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.field.value.set` передает значения полей системы кадрового учета для сотрудников.", "operationId": "humanresources_hcmlink_field_value_set", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-field-value-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета или идентификатор компании CRM." }, "data": { "type": "array", "items": {}, "description": "| Список значений полей (подробное описание) ||" }, "job": { "type": "object", "description": "| Данные для обновления задания синхронизации (подробное описание)." }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета." }, "employee": { "type": "string", "description": "| Код сотрудника в системе кадрового учета." }, "value": { "type": "string", "description": "| Значение поля ||" }, "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Новые данные задания синхронизации (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" } }, "required": [ "company", "data", "field", "employee", "value", "id", "fields", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "company": { "type": "string", "description": "| Код компании в системе кадрового учета или идентификатор компании CRM." }, "data": { "type": "array", "items": {}, "description": "| Список значений полей (подробное описание) ||" }, "job": { "type": "object", "description": "| Данные для обновления задания синхронизации (подробное описание)." }, "field": { "type": "string", "description": "| Код поля в системе кадрового учета." }, "employee": { "type": "string", "description": "| Код сотрудника в системе кадрового учета." }, "value": { "type": "string", "description": "| Значение поля ||" }, "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Новые данные задания синхронизации (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" } }, "required": [ "company", "data", "field", "employee", "value", "id", "fields", "status" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.job.status.get": { "post": { "summary": "Получить статус задания HCM Link humanresources.hcmlink.job.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.job.status.get` проверяет, активно ли задание синхронизации HCM Link.", "operationId": "humanresources_hcmlink_job_status_get", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-job-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.hcmlink.job.update": { "post": { "summary": "Обновить задание HCM Link humanresources.hcmlink.job.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `humanresources.hcmlink.job.update` обновляет задание синхронизации HCM Link.", "operationId": "humanresources_hcmlink_job_update", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/hcm-link/humanresources-hcmlink-job-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Данные задания (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" }, "data": { "type": "object", "description": "| Дополнительные данные задания ||" } }, "required": [ "id", "fields", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задания синхронизации." }, "fields": { "type": "object", "description": "| Данные задания (подробное описание) ||" }, "status": { "type": "string", "description": "| Новый статус задания." }, "total": { "type": "integer", "description": "| Общее количество элементов в задании ||" }, "sent": { "type": "integer", "description": "| Количество обработанных элементов ||" }, "data": { "type": "object", "description": "| Дополнительные данные задания ||" } }, "required": [ "id", "fields", "status" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources.hcmlink" ] } ] } }, "/humanresources.node.add": { "post": { "summary": "Создать отдел humanresources.node.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_add", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип создаваемого элемента структуры." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского отдела или команды." }, "description": { "type": "string", "description": "| Описание отдела или команды ||" }, "colorName": { "type": "string", "description": "| Цвет команды." }, "userIds": { "type": "object", "description": "| Пользователи, которых нужно добавить в отдел или команду. Описание структуры объекта" }, "moveUsersToNode": { "type": "boolean", "description": "| Определяет, нужно ли переводить пользователей из `userIds` в новый отдел." }, "createChat": { "type": "boolean", "description": "| Определяет, нужно ли создать новый чат для отдела." }, "bindingChatIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих чатов, которые нужно привязать к отделу." }, "createChannel": { "type": "boolean", "description": "| Определяет, нужно ли создать новый канал для отдела." }, "bindingChannelIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих каналов, которые нужно привязать к отделу." }, "createCollab": { "type": "boolean", "description": "| Определяет, нужно ли создать новый коллаб для отдела, если коллабы доступны в тарифе." }, "bindingCollabIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих коллабов, которые нужно привязать к отделу." }, "settings": { "type": "object", "description": "| Дополнительные настройки отдела или команды. Описание структуры объекта ||" }, "MEMBER_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей отдела ||" }, "MEMBER_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя отдела ||" }, "MEMBER_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы сотрудников отдела ||" }, "MEMBER_TEAM_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей команды ||" }, "MEMBER_TEAM_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя команды ||" }, "MEMBER_TEAM_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы участников команды ||" }, "BUSINESS_PROC_AUTHORITY": { "type": "array", "items": {}, "description": "| Роли, которым разрешено работать с бизнес-процессами отдела или команды." }, "REPORTS_AUTHORITY": { "type": "array", "items": {}, "description": "| Роли, которым разрешено работать с отчетами отдела или команды." } }, "required": [ "type", "parentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип создаваемого элемента структуры." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского отдела или команды." }, "description": { "type": "string", "description": "| Описание отдела или команды ||" }, "colorName": { "type": "string", "description": "| Цвет команды." }, "userIds": { "type": "object", "description": "| Пользователи, которых нужно добавить в отдел или команду. Описание структуры объекта" }, "moveUsersToNode": { "type": "boolean", "description": "| Определяет, нужно ли переводить пользователей из `userIds` в новый отдел." }, "createChat": { "type": "boolean", "description": "| Определяет, нужно ли создать новый чат для отдела." }, "bindingChatIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих чатов, которые нужно привязать к отделу." }, "createChannel": { "type": "boolean", "description": "| Определяет, нужно ли создать новый канал для отдела." }, "bindingChannelIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих каналов, которые нужно привязать к отделу." }, "createCollab": { "type": "boolean", "description": "| Определяет, нужно ли создать новый коллаб для отдела, если коллабы доступны в тарифе." }, "bindingCollabIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов существующих коллабов, которые нужно привязать к отделу." }, "settings": { "type": "object", "description": "| Дополнительные настройки отдела или команды. Описание структуры объекта ||" }, "MEMBER_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей отдела ||" }, "MEMBER_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя отдела ||" }, "MEMBER_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы сотрудников отдела ||" }, "MEMBER_TEAM_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей команды ||" }, "MEMBER_TEAM_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя команды ||" }, "MEMBER_TEAM_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы участников команды ||" }, "BUSINESS_PROC_AUTHORITY": { "type": "array", "items": {}, "description": "| Роли, которым разрешено работать с бизнес-процессами отдела или команды." }, "REPORTS_AUTHORITY": { "type": "array", "items": {}, "description": "| Роли, которым разрешено работать с отчетами отдела или команды." } }, "required": [ "type", "parentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.children": { "post": { "summary": "Получить дочерние отделы humanresources.node.children", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_children", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-children.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор родительского отдела или команды." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела или команды, которые нужно вернуть." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор родительского отдела или команды." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела или команды, которые нужно вернуть." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.communication.edit": { "post": { "summary": "Изменить коммуникации отдела humanresources.node.communication.edit", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_communication_edit", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-communication/humanresources-node-communication-edit.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "communicationType": { "type": "string", "description": "| Тип коммуникации." }, "createDefault": { "type": "boolean", "description": "| Создает коммуникацию по умолчанию для отдела или команды." }, "ids": { "type": "array", "items": {}, "description": "| Идентификаторы коммуникаций, которые нужно привязать." }, "removeIds": { "type": "array", "items": {}, "description": "| Идентификаторы коммуникаций, которые нужно отвязать." }, "withChildren": { "type": "boolean", "description": "| Применяет изменение к дочерним отделам и командам." } }, "required": [ "nodeId", "communicationType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "communicationType": { "type": "string", "description": "| Тип коммуникации." }, "createDefault": { "type": "boolean", "description": "| Создает коммуникацию по умолчанию для отдела или команды." }, "ids": { "type": "array", "items": {}, "description": "| Идентификаторы коммуникаций, которые нужно привязать." }, "removeIds": { "type": "array", "items": {}, "description": "| Идентификаторы коммуникаций, которые нужно отвязать." }, "withChildren": { "type": "boolean", "description": "| Применяет изменение к дочерним отделам и командам." } }, "required": [ "nodeId", "communicationType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.communication.list": { "post": { "summary": "Получить коммуникации отдела humanresources.node.communication.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_communication_list", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-communication/humanresources-node-communication-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.count": { "post": { "summary": "Получить количество отделов humanresources.node.count", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_count", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-count.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.edit": { "post": { "summary": "Обновить отдел humanresources.node.edit", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_edit", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-edit.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "description": { "type": "string", "description": "| Новое описание отдела или команды ||" }, "colorName": { "type": "string", "description": "| Новый цвет команды." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "description": { "type": "string", "description": "| Новое описание отдела или команды ||" }, "colorName": { "type": "string", "description": "| Новый цвет команды." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.field.get": { "post": { "summary": "Получить поле отдела humanresources.node.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_field_get", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.field.list": { "post": { "summary": "Получить список полей отдела humanresources.node.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_field_list", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.get": { "post": { "summary": "Получить отдел humanresources.node.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_get", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела, которые нужно вернуть." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела, которые нужно вернуть." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.list": { "post": { "summary": "Получить список отделов humanresources.node.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_list", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип элемента структуры." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела или команды, которые нужно вернуть." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип элемента структуры." }, "select": { "type": "array", "items": {}, "description": "| Список полей отдела или команды, которые нужно вернуть." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.add": { "post": { "summary": "Добавить участников в отдел humanresources.node.member.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_add", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в отдел или команду. Если пользователь уже состоит в этом отделе или команде, метод обновит его роль." }, "role": { "type": "string", "description": "| Роль, которую нужно назначить всем пользователям из `userIds`." } }, "required": [ "nodeId", "userIds", "role" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в отдел или команду. Если пользователь уже состоит в этом отделе или команде, метод обновит его роль." }, "role": { "type": "string", "description": "| Роль, которую нужно назначить всем пользователям из `userIds`." } }, "required": [ "nodeId", "userIds", "role" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.field.get": { "post": { "summary": "Получить поле участника отдела humanresources.node.member.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_field_get", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.field.list": { "post": { "summary": "Получить список полей участника отдела humanresources.node.member.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_field_list", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.move": { "post": { "summary": "Перенести участников в отдел humanresources.node.member.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_move", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-move.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор целевого отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно перенести." }, "role": { "type": "string", "description": "| Роль, которую нужно назначить перенесенным участникам." } }, "required": [ "nodeId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор целевого отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно перенести." }, "role": { "type": "string", "description": "| Роль, которую нужно назначить перенесенным участникам." } }, "required": [ "nodeId", "userIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.remove": { "post": { "summary": "Удалить участников из отдела humanresources.node.member.remove", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_remove", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-remove.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно удалить." } }, "required": [ "nodeId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно удалить." } }, "required": [ "nodeId", "userIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.member.set": { "post": { "summary": "Обновить состав участников отдела humanresources.node.member.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_member_set", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node-member/humanresources-node-member-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "object", "description": "| Объект со списками идентификаторов пользователей в формате `{\"Роль_пользователя\": [Идентификатор_пользователя]}`. Описание структуры объекта" }, "MEMBER_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей отдела ||" }, "MEMBER_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя отдела ||" }, "MEMBER_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы сотрудников отдела ||" }, "MEMBER_TEAM_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей команды ||" }, "MEMBER_TEAM_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя команды ||" }, "MEMBER_TEAM_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы участников команды ||" } }, "required": [ "nodeId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "nodeId": { "type": "integer", "description": "| Идентификатор отдела или команды." }, "userIds": { "type": "object", "description": "| Объект со списками идентификаторов пользователей в формате `{\"Роль_пользователя\": [Идентификатор_пользователя]}`. Описание структуры объекта" }, "MEMBER_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей отдела ||" }, "MEMBER_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя отдела ||" }, "MEMBER_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы сотрудников отдела ||" }, "MEMBER_TEAM_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы руководителей команды ||" }, "MEMBER_TEAM_DEPUTY_HEAD": { "type": "array", "items": {}, "description": "| Идентификаторы заместителей руководителя команды ||" }, "MEMBER_TEAM_EMPLOYEE": { "type": "array", "items": {}, "description": "| Идентификаторы участников команды ||" } }, "required": [ "nodeId", "userIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.move": { "post": { "summary": "Переместить отдел humanresources.node.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_move", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-move.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды, который нужно переместить." }, "parentId": { "type": "integer", "description": "| Идентификатор нового родительского отдела." } }, "required": [ "id", "parentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор отдела или команды, который нужно переместить." }, "parentId": { "type": "integer", "description": "| Идентификатор нового родительского отдела." } }, "required": [ "id", "parentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/humanresources.node.search": { "post": { "summary": "Найти отделы humanresources.node.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "humanresources_node_search", "tags": [ "Структура компании" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/departments/node/humanresources-node-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип элемента структуры." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского отдела для ограничения поиска." }, "pagination": { "type": "object", "description": "| Параметр постраничной навигации." } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип элемента структуры." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского отдела для ограничения поиска." }, "pagination": { "type": "object", "description": "| Параметр постраничной навигации." } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "humanresources" ] } ] } }, "/iblock.element.field.get": { "post": { "summary": "Получить поле элемента инфоблока iblock.element.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "iblock_element_field_get", "tags": [ "iblock" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/iblock/iblock-element-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "iblock" ] } ] } }, "/iblock.element.field.list": { "post": { "summary": "Получить список полей элемента инфоблока iblock.element.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "iblock_element_field_list", "tags": [ "iblock" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/iblock/iblock-element-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "iblock" ] } ] } }, "/iblock.element.get": { "post": { "summary": "Получить элемент инфоблока iblock.element.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "iblock_element_get", "tags": [ "iblock" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/iblock/iblock-element-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "iblock": { "type": "integer", "description": "| Идентификатор инфоблока, в котором находится элемент. Значение должно быть больше `0`." }, "id": { "type": "integer", "description": "| Идентификатор элемента." }, "select": { "type": "array", "items": {}, "description": "| Массив полей элемента, которые нужно вернуть в ответе." } }, "required": [ "iblock", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "iblock": { "type": "integer", "description": "| Идентификатор инфоблока, в котором находится элемент. Значение должно быть больше `0`." }, "id": { "type": "integer", "description": "| Идентификатор элемента." }, "select": { "type": "array", "items": {}, "description": "| Массив полей элемента, которые нужно вернуть в ответе." } }, "required": [ "iblock", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "iblock" ] } ] } }, "/iblock.element.list": { "post": { "summary": "Получить список элементов инфоблока iblock.element.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "iblock_element_list", "tags": [ "iblock" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/iblock/iblock-element-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей элемента, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\":\"ASC\"}`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество элементов на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) * limit`. Если передан `page`, значение `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей элемента, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`, например `{\"id\":\"ASC\"}`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Количество элементов на странице. Значения больше `1000` уменьшаются до `1000`. Ноль, отрицательное и нечисловое значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) * limit`. Если передан `page`, значение `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество записей, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "iblock" ] } ] } }, "/im.chat.add": { "post": { "summary": "Создать чат im.chat.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.add` создает новый чат.", "operationId": "im_chat_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-chat-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в чат." }, "TYPE": { "type": "string", "description": "| Тип чата:" }, "TITLE": { "type": "string", "description": "| Название чата." }, "DESCRIPTION": { "type": "string", "description": "| Описание чата ||" }, "COLOR": { "type": "string", "description": "| Цвет чата. Возможные значения:" }, "MESSAGE": { "type": "string", "description": "| Первое сообщение в чате ||" }, "AVATAR": { "type": "string", "description": "| Аватар чата в формате строки base64." }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для связи чата с внешним контекстом." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." }, "COPILOT_MAIN_ROLE": { "type": "string", "description": "| Код основной роли для BitrixGPT." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в чат." }, "TYPE": { "type": "string", "description": "| Тип чата:" }, "TITLE": { "type": "string", "description": "| Название чата." }, "DESCRIPTION": { "type": "string", "description": "| Описание чата ||" }, "COLOR": { "type": "string", "description": "| Цвет чата. Возможные значения:" }, "MESSAGE": { "type": "string", "description": "| Первое сообщение в чате ||" }, "AVATAR": { "type": "string", "description": "| Аватар чата в формате строки base64." }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для связи чата с внешним контекстом." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." }, "COPILOT_MAIN_ROLE": { "type": "string", "description": "| Код основной роли для BitrixGPT." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.get": { "post": { "summary": "Получить идентификатор чата im.chat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.get` получает идентификатор чата.", "operationId": "im_chat_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-chat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для связи чата с внешним контекстом. Передается строкой." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для связи чата с внешним контекстом. Передается строкой." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.leave": { "post": { "summary": "Покинуть чат im.chat.leave", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.leave` удаляет текущего пользователя из чата.", "operationId": "im_chat_leave", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-users/im-chat-leave.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.mute": { "post": { "summary": "Отключить уведомления от чата im.chat.mute", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.mute` отключает или включает уведомления в указанном чате.", "operationId": "im_chat_mute", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/special-operations/im-chat-mute.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MUTE": { "type": "string", "description": "| Управление уведомлениями:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MUTE": { "type": "string", "description": "| Управление уведомлениями:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.setOwner": { "post": { "summary": "Сменить владельца чата im.chat.setOwner", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.setOwner` меняет владельца чата.", "operationId": "im_chat_setOwner", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-update/im-chat-set-owner.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "USER_ID": { "type": "integer", "description": "| Идентификатор нового владельца чата." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "USER_ID": { "type": "integer", "description": "| Идентификатор нового владельца чата." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateAvatar": { "post": { "summary": "Изменить аватар чата im.chat.updateAvatar", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.updateAvatar` обновляет аватар чата.", "operationId": "im_chat_updateAvatar", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-update/im-chat-update-avatar.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "AVATAR": { "type": "string", "description": "| Изображение в формате Base64." } }, "required": [ "CHAT_ID", "AVATAR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "AVATAR": { "type": "string", "description": "| Изображение в формате Base64." } }, "required": [ "CHAT_ID", "AVATAR" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateColor": { "post": { "summary": "Изменить цвет чата im.chat.updateColor", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.updateColor` обновляет цвет чата для мобильного приложения.", "operationId": "im_chat_updateColor", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-update/im-chat-update-color.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "COLOR": { "type": "string", "description": "| Цвет чата. Отображается в мобильном приложении и там, где у чата нет аватара. Возможные значения:" } }, "required": [ "CHAT_ID", "COLOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "COLOR": { "type": "string", "description": "| Цвет чата. Отображается в мобильном приложении и там, где у чата нет аватара. Возможные значения:" } }, "required": [ "CHAT_ID", "COLOR" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateTitle": { "post": { "summary": "Изменить заголовок чата im.chat.updateTitle", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.updateTitle` обновляет заголовок чата.", "operationId": "im_chat_updateTitle", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-update/im-chat-update-title.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "TITLE": { "type": "string", "description": "| Заголовок чата." } }, "required": [ "CHAT_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Передайте число без префикса `chat`. Обязателен, если не передан `DIALOG_ID`." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор чата. Можно передать вместо `CHAT_ID`." }, "TITLE": { "type": "string", "description": "| Заголовок чата." } }, "required": [ "CHAT_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.add": { "post": { "summary": "Пригласить участников в чат im.chat.user.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.user.add` добавляет пользователей в чат.", "operationId": "im_chat_user_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-users/im-chat-user-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в чат." }, "HIDE_HISTORY": { "type": "string", "description": "| Скрыть историю чата для добавляемых пользователей:" } }, "required": [ "CHAT_ID", "USERS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, которых нужно добавить в чат." }, "HIDE_HISTORY": { "type": "string", "description": "| Скрыть историю чата для добавляемых пользователей:" } }, "required": [ "CHAT_ID", "USERS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.delete": { "post": { "summary": "Исключить участников из чата im.chat.user.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.user.delete` удаляет пользователя из чата.", "operationId": "im_chat_user_delete", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-users/im-chat-user-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которого нужно исключить из чата." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которого нужно исключить из чата." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.list": { "post": { "summary": "Получить идентификаторы участников чата im.chat.user.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.chat.user.list` возвращает список идентификаторов участников чата.", "operationId": "im_chat_user_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-users/im-chat-user-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.counters.get": { "post": { "summary": "Получить счетчики im.counters.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.counters.get` получает счетчики непрочитанных сообщений и уведомлений для текущего пользователя.", "operationId": "im_counters_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-counters-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.colleagues.list": { "post": { "summary": "Получить список коллег текущего пользователя im.department.colleagues.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.department.colleagues.list` получает список коллег текущего пользователя. Для руководителя метод вернет список подчиненных и всех руководителей.", "operationId": "im_department_colleagues_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/departments/im-department-colleagues-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки пользователей. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки пользователей. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.employees.get": { "post": { "summary": "Получить список сотрудников подразделений im.department.employees.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.department.employees.get` получает список сотрудников указанных подразделений.", "operationId": "im_department_employees_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/departments/im-department-employees-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.get": { "post": { "summary": "Получить информацию о подразделении im.department.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.department.get` получает данные о подразделениях по их идентификаторам `ID`.", "operationId": "im_department_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/departments/im-department-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать данные руководителя подразделения." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать данные руководителя подразделения." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.managers.get": { "post": { "summary": "Получить список руководителей подразделений im.department.managers.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.department.managers.get` получает список руководителей указанных подразделений.", "operationId": "im_department_managers_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/departments/im-department-managers-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| Массив идентификаторов подразделений. Можно передать строку с JSON-массивом идентификаторов." }, "USER_DATA": { "type": "string", "description": "| Возвращать подробные данные пользователей." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.get": { "post": { "summary": "Получить данные о чате im.dialog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.get` получает информацию о чате.", "operationId": "im_dialog_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-dialog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.messages.get": { "post": { "summary": "Получить список последних сообщений im.dialog.messages.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.messages.get` получает сообщения указанного диалога, в том числе системные. Не поддерживает стандартную постраничную навигацию из-за потенциально большого объема данных", "operationId": "im_dialog_messages_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-dialog-messages-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор сообщения, относительно которого нужно загрузить более старые сообщения. Метод вернет сообщения с идентификатором меньше указанного." }, "FIRST_ID": { "type": "integer", "description": "| Идентификатор сообщения, относительно которого нужно загрузить более новые сообщения. Метод вернет сообщения с идентификатором больше указанного." }, "LIMIT": { "type": "integer", "description": "| Ограничение на количество сообщений в ответе. Если не переданы `LAST_ID` и `FIRST_ID` — метод вернет последние сообщения диалога с учетом `LIMIT`." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор сообщения, относительно которого нужно загрузить более старые сообщения. Метод вернет сообщения с идентификатором меньше указанного." }, "FIRST_ID": { "type": "integer", "description": "| Идентификатор сообщения, относительно которого нужно загрузить более новые сообщения. Метод вернет сообщения с идентификатором больше указанного." }, "LIMIT": { "type": "integer", "description": "| Ограничение на количество сообщений в ответе. Если не переданы `LAST_ID` и `FIRST_ID` — метод вернет последние сообщения диалога с учетом `LIMIT`." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.messages.search": { "post": { "summary": "Найти сообщение в чате im.dialog.messages.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.messages.search` выполняет поиск сообщений в чате.", "operationId": "im_dialog_messages_search", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-dialog-messages-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SEARCH_MESSAGE": { "type": "string", "description": "| Строка поиска по тексту сообщения." }, "DATE_FROM": { "type": "string", "format": "date-time", "description": "| Начало периода поиска в формате ISO 8601 (RFC3339) ||" }, "DATE_TO": { "type": "string", "format": "date-time", "description": "| Конец периода поиска в формате ISO 8601 (RFC3339) ||" }, "DATE": { "type": "string", "format": "date-time", "description": "| Поиск сообщений за конкретную дату в формате ISO 8601 (RFC3339)." }, "ORDER": { "type": "object", "description": "| Параметры сортировки." }, "LIMIT": { "type": "integer", "description": "| Количество возвращаемых сообщений." }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего сообщения из предыдущей выборки для пагинации ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SEARCH_MESSAGE": { "type": "string", "description": "| Строка поиска по тексту сообщения." }, "DATE_FROM": { "type": "string", "format": "date-time", "description": "| Начало периода поиска в формате ISO 8601 (RFC3339) ||" }, "DATE_TO": { "type": "string", "format": "date-time", "description": "| Конец периода поиска в формате ISO 8601 (RFC3339) ||" }, "DATE": { "type": "string", "format": "date-time", "description": "| Поиск сообщений за конкретную дату в формате ISO 8601 (RFC3339)." }, "ORDER": { "type": "object", "description": "| Параметры сортировки." }, "LIMIT": { "type": "integer", "description": "| Количество возвращаемых сообщений." }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего сообщения из предыдущей выборки для пагинации ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.read": { "post": { "summary": "Установить признак «прочитано» у сообщений im.dialog.read", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.read` устанавливает признак «прочитано» для сообщений диалога до указанного сообщения включительно.", "operationId": "im_dialog_read", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-dialog-read.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор последнего прочитанного сообщения. Если не передан — метод устанавливает признак прочтения для всех непрочитанных сообщений ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор последнего прочитанного сообщения. Если не передан — метод устанавливает признак прочтения для всех непрочитанных сообщений ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.read.all": { "post": { "summary": "Установить признак «прочитано» у всех чатов im.dialog.read.all", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.read.all` устанавливает признак «прочитано» для всех чатов текущего пользователя.", "operationId": "im_dialog_read_all", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/special-operations/im-dialog-read-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.unread": { "post": { "summary": "Установить признак «не прочитано» у сообщений im.dialog.unread", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.unread` устанавливает признак «не прочитано» для сообщений в диалоге начиная с указанного сообщения.", "operationId": "im_dialog_unread", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-dialog-unread.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор первого непрочитанного сообщения ||" } }, "required": [ "DIALOG_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор первого непрочитанного сообщения ||" } }, "required": [ "DIALOG_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.users.list": { "post": { "summary": "Получить список участников im.dialog.users.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.users.list` возвращает подробную информацию об участниках диалога с поддержкой пагинации.", "operationId": "im_dialog_users_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/chat-users/im-dialog-users-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "SKIP_EXTERNAL": { "type": "string", "description": "| Исключить системных пользователей:" }, "SKIP_EXTERNAL_EXCEPT_TYPES": { "type": "string", "description": "| Список типов системных пользователей, которых нужно оставить в выборке, через запятую." }, "LIMIT": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего пользователя из выборки `LIMIT`." }, "OFFSET": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "SKIP_EXTERNAL": { "type": "string", "description": "| Исключить системных пользователей:" }, "SKIP_EXTERNAL_EXCEPT_TYPES": { "type": "string", "description": "| Список типов системных пользователей, которых нужно оставить в выборке, через запятую." }, "LIMIT": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего пользователя из выборки `LIMIT`." }, "OFFSET": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.writing": { "post": { "summary": "Отправить признак «Пользователь пишет» im.dialog.writing", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.dialog.writing` отправляет в чат индикатор «Пользователь пишет».", "operationId": "im_dialog_writing", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-dialog-writing.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.commit": { "post": { "summary": "Добавить файл в чат im.disk.file.commit", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод оставлен для поддержки существующих интеграций. Для новой разработки используйте [im.v2.File.upload](../../chat-bots/chat-bots-v2/im.v2/files/file-upload.md): он загружает файл в чат одним вызовом, без предварительной загрузки файла через методы Диска.", "operationId": "im_disk_file_commit", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/files/im-disk-file-commit.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате:" }, "FILE_ID": { "type": "integer", "description": "| Идентификатор файла на Диске. Можно передать массив." }, "UPLOAD_ID": { "type": "integer", "description": "| Идентификатор файла на Диске. Можно передать массив." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения с файлом ||" }, "SILENT_MODE": { "type": "string", "description": "| Параметр для чата Открытых линий" }, "AS_FILE": { "type": "string", "description": "| Отправить как файл. Только для `UPLOAD_ID`." } }, "required": [ "CHAT_ID", "DIALOG_ID", "FILE_ID", "UPLOAD_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате:" }, "FILE_ID": { "type": "integer", "description": "| Идентификатор файла на Диске. Можно передать массив." }, "UPLOAD_ID": { "type": "integer", "description": "| Идентификатор файла на Диске. Можно передать массив." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения с файлом ||" }, "SILENT_MODE": { "type": "string", "description": "| Параметр для чата Открытых линий" }, "AS_FILE": { "type": "string", "description": "| Отправить как файл. Только для `UPLOAD_ID`." } }, "required": [ "CHAT_ID", "DIALOG_ID", "FILE_ID", "UPLOAD_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.delete": { "post": { "summary": "Удалить файл из папки чата im.disk.file.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к группе `im.disk.*` предыдущего поколения API мессенджера. Замены в `im.v2` у него пока нет — используйте этот метод.", "operationId": "im_disk_file_delete", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/files/im-disk-file-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата ||" }, "FILE_ID": { "type": "integer", "description": "| Идентификатор файла ||" } }, "required": [ "CHAT_ID", "FILE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата ||" }, "FILE_ID": { "type": "integer", "description": "| Идентификатор файла ||" } }, "required": [ "CHAT_ID", "FILE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.save": { "post": { "summary": "Сохранить файл на свой диск im.disk.file.save", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к группе `im.disk.*` предыдущего поколения API мессенджера. Замены в `im.v2` у него пока нет — используйте этот метод.", "operationId": "im_disk_file_save", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/files/im-disk-file-save.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILE_ID": { "type": "integer", "description": "| Идентификатор файла ||" } }, "required": [ "FILE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILE_ID": { "type": "integer", "description": "| Идентификатор файла ||" } }, "required": [ "FILE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.folder.get": { "post": { "summary": "Получить папку хранения файлов чата im.disk.folder.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод оставлен для поддержки существующих интеграций. Чтобы загрузить файл в чат, папка больше не нужна — используйте [im.v2.File.upload](../../chat-bots/chat-bots-v2/im.v2/files/file-upload.md).", "operationId": "im_disk_folder_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/files/im-disk-folder-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Обязателен, если не передан `DIALOG_ID` ||" }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор. Обязателен, если не передан `CHAT_ID` ||" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата. Обязателен, если не передан `DIALOG_ID` ||" }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chatXXX`, где `XXX` — идентификатор. Обязателен, если не передан `CHAT_ID` ||" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.add": { "post": { "summary": "Отправить сообщение im.message.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.add` отправляет сообщение в чат.", "operationId": "im_message_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE": { "type": "string", "description": "| Текст сообщения. Обязателен, если не передан `ATTACH`." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Признак системного сообщения." }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки." }, "REPLY_ID": { "type": "integer", "description": "| Идентификатор сообщения, на которое отправляется ответ. Сообщение для ответа должно быть в том же чате." } }, "required": [ "DIALOG_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "MESSAGE": { "type": "string", "description": "| Текст сообщения. Обязателен, если не передан `ATTACH`." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Признак системного сообщения." }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки." }, "REPLY_ID": { "type": "integer", "description": "| Идентификатор сообщения, на которое отправляется ответ. Сообщение для ответа должно быть в том же чате." } }, "required": [ "DIALOG_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.command": { "post": { "summary": "Выполнить команду чат-бота im.message.command", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.command` отправляет команду чат-боту от имени текущего пользователя в контексте сообщения, так же как нажатие кнопки клавиатуры с параметром `COMMAND`.", "operationId": "im_message_command", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-command.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, в контексте которого выполняется команда." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор бота." }, "COMMAND": { "type": "string", "description": "| Команда бота." }, "COMMAND_PARAMS": { "type": "string", "description": "| Параметры команды — текст, который передается боту после команды ||" } }, "required": [ "MESSAGE_ID", "BOT_ID", "COMMAND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, в контексте которого выполняется команда." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор бота." }, "COMMAND": { "type": "string", "description": "| Команда бота." }, "COMMAND_PARAMS": { "type": "string", "description": "| Параметры команды — текст, который передается боту после команды ||" } }, "required": [ "MESSAGE_ID", "BOT_ID", "COMMAND" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.delete": { "post": { "summary": "Удалить сообщение im.message.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.delete` удаляет сообщение.", "operationId": "im_message_delete", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.like": { "post": { "summary": "Изменить статус «Мне нравится» im.message.like", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.like` ставит или снимает отметку «Мне нравится» для сообщения.", "operationId": "im_message_like", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-like.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "ACTION": { "type": "string", "description": "| Действие с реакцией на сообщение." } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "ACTION": { "type": "string", "description": "| Действие с реакцией на сообщение." } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.share": { "post": { "summary": "Создать объект на основании сообщения im.message.share", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.share` создает объект на основании сообщения.", "operationId": "im_message_share", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-share.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "TYPE": { "type": "string", "description": "| Тип создаваемого объекта." } }, "required": [ "MESSAGE_ID", "DIALOG_ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "TYPE": { "type": "string", "description": "| Тип создаваемого объекта." } }, "required": [ "MESSAGE_ID", "DIALOG_ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.update": { "post": { "summary": "Изменить сообщение im.message.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.message.update` изменяет текст и параметры уже отправленного сообщения.", "operationId": "im_message_update", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/messages/im-message-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "MESSAGE": { "type": "string", "description": "| Новый текст сообщения. Если передать пустое значение, сообщение будет удалено." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки." }, "IS_EDITED": { "type": "string", "description": "| Флаг отметки «изменено»:" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "MESSAGE": { "type": "string", "description": "| Новый текст сообщения. Если передать пустое значение, сообщение будет удалено." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки." }, "IS_EDITED": { "type": "string", "description": "| Флаг отметки «изменено»:" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify": { "post": { "summary": "Отправить уведомление im.notify", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify` отправляет уведомление пользователю.", "operationId": "im_notify", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "TYPE": { "type": "string", "description": "| Тип уведомления." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений." }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты. Для `TYPE: SYSTEM` при вызове из приложения первой строкой текста метод добавляет название приложения ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "TYPE": { "type": "string", "description": "| Тип уведомления." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений." }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты. Для `TYPE: SYSTEM` при вызове из приложения первой строкой текста метод добавляет название приложения ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.answer": { "post": { "summary": "Ответить на уведомление с быстрым ответом im.notify.answer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.answer` отправляет текстовый быстрый ответ на уведомление текущего пользователя.", "operationId": "im_notify_answer", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-answer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Идентификатор уведомления, которое поддерживает быстрый ответ. Получить идентификатор можно методом im.notify.get." }, "ANSWER_TEXT": { "type": "string", "description": "| Текст быстрого ответа." } }, "required": [ "NOTIFY_ID", "ANSWER_TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Идентификатор уведомления, которое поддерживает быстрый ответ. Получить идентификатор можно методом im.notify.get." }, "ANSWER_TEXT": { "type": "string", "description": "| Текст быстрого ответа." } }, "required": [ "NOTIFY_ID", "ANSWER_TEXT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.confirm": { "post": { "summary": "Взаимодействовать с кнопками уведомлений im.notify.confirm", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.confirm` нажимает кнопку в уведомлении текущего пользователя и удаляет это уведомление.", "operationId": "im_notify_confirm", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-confirm.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Идентификатор уведомления с кнопками. Получить идентификатор можно методом im.notify.get, у таких уведомлений поле `notify_type` равно `1`." }, "NOTIFY_VALUE": { "type": "string", "description": "| Значение выбранной кнопки. Значения задает модуль, который отправил уведомление." } }, "required": [ "NOTIFY_ID", "NOTIFY_VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Идентификатор уведомления с кнопками. Получить идентификатор можно методом im.notify.get, у таких уведомлений поле `notify_type` равно `1`." }, "NOTIFY_VALUE": { "type": "string", "description": "| Значение выбранной кнопки. Значения задает модуль, который отправил уведомление." } }, "required": [ "NOTIFY_ID", "NOTIFY_VALUE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.delete": { "post": { "summary": "Удалить уведомление im.notify.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.delete` удаляет уведомление по `ID` или по тегам `TAG` и `SUB_TAG`.", "operationId": "im_notify_delete", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer" }, "TAG": { "type": "string", "description": "| Тег, переданный в `TAG` при отправке уведомления. Метод удаляет уведомления текущего приложения с этим тегом у всех получателей." }, "SUB_TAG": { "type": "string", "description": "| Тег, переданный в `SUB_TAG` при отправке уведомления. Метод удаляет уведомления текущего приложения с этим тегом у всех получателей ||" }, "CLIENT_ID": { "type": "string", "description": "| Идентификатор, по которому метод вычисляет ключ приложения для удаления по `TAG` или `SUB_TAG` через вебхук. Без него вызов через вебхук без `ID` вернет ошибку `ACCESS_DENIED`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer" }, "TAG": { "type": "string", "description": "| Тег, переданный в `TAG` при отправке уведомления. Метод удаляет уведомления текущего приложения с этим тегом у всех получателей." }, "SUB_TAG": { "type": "string", "description": "| Тег, переданный в `SUB_TAG` при отправке уведомления. Метод удаляет уведомления текущего приложения с этим тегом у всех получателей ||" }, "CLIENT_ID": { "type": "string", "description": "| Идентификатор, по которому метод вычисляет ключ приложения для удаления по `TAG` или `SUB_TAG` через вебхук. Без него вызов через вебхук без `ID` вернет ошибку `ACCESS_DENIED`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.get": { "post": { "summary": "Получить уведомления im.notify.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.get` возвращает уведомления текущего пользователя постранично.", "operationId": "im_notify_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего уведомления на предыдущей странице — поле `id` последнего элемента массива `notifications`. Метод вернет уведомления с идентификатором меньше `LAST_ID`." }, "LAST_TYPE": { "type": "integer", "description": "| Тип последнего уведомления на предыдущей странице. Допустимые значения:" }, "LIMIT": { "type": "integer", "description": "| Количество уведомлений на странице. По умолчанию — `50`, максимум — `50`. Большее значение метод уменьшает до `50`." }, "CONVERT_TEXT": { "type": "string", "description": "| Метод принимает параметр, но не учитывает его ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего уведомления на предыдущей странице — поле `id` последнего элемента массива `notifications`. Метод вернет уведомления с идентификатором меньше `LAST_ID`." }, "LAST_TYPE": { "type": "integer", "description": "| Тип последнего уведомления на предыдущей странице. Допустимые значения:" }, "LIMIT": { "type": "integer", "description": "| Количество уведомлений на странице. По умолчанию — `50`, максимум — `50`. Большее значение метод уменьшает до `50`." }, "CONVERT_TEXT": { "type": "string", "description": "| Метод принимает параметр, но не учитывает его ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.history.search": { "post": { "summary": "Поиск по истории уведомлений im.notify.history.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.history.search` ищет уведомления текущего пользователя по тексту, типу, дате и автору.", "operationId": "im_notify_history_search", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-history-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SEARCH_TEXT": { "type": "string", "description": "| Текст для поиска в тексте уведомления. Регистр не учитывается." }, "SEARCH_TYPE": { "type": "string", "description": "| Тип уведомления в формате `MODULE` или ```MODULE|EVENT```, например `calendar` или ```calendar|change```. Коды типов возвращает метод im.notify.schema.get." }, "SEARCH_TYPES": { "type": "array", "items": {}, "description": "| Массив типов уведомлений, например `[\"calendar\", \"tasks\"]`." }, "SEARCH_DATE": { "type": "string", "format": "date-time", "description": "| Дата и время в формате RFC 3339, например `2026-11-10T00:00:00+03:00`. Метод найдет уведомления, созданные в течение 24 часов от этого момента." }, "SEARCH_DATE_FROM": { "type": "string", "format": "date-time", "description": "| Начало периода в формате RFC 3339. Передавайте вместе с `SEARCH_DATE_TO`." }, "SEARCH_DATE_TO": { "type": "string", "format": "date-time", "description": "| Конец периода в формате RFC 3339. Передавайте вместе с `SEARCH_DATE_FROM`. Метод добавляет к значению 24 часа: при `2026-11-10T00:00:00+03:00` в выборку попадут уведомления за 10 ноября ||" }, "SEARCH_AUTHORS": { "type": "array", "items": {}, "description": "| Массив идентификаторов авторов уведомлений, например `[1, 15]`. Значение `0` выбирает системные уведомления." }, "GROUP_TAG": { "type": "string", "description": "| Группа уведомлений для дополнительной фильтрации. Допустимые значения:" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего уведомления на предыдущей странице — поле `id` последнего элемента массива `notifications`. Метод вернет уведомления с идентификатором меньше `LAST_ID`." }, "LIMIT": { "type": "integer", "description": "| Количество уведомлений на странице. По умолчанию — `50`, максимум — `50`. Большее значение метод уменьшает до `50`." }, "CONVERT_TEXT": { "type": "string", "description": "| Метод принимает параметр, но не учитывает его ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SEARCH_TEXT": { "type": "string", "description": "| Текст для поиска в тексте уведомления. Регистр не учитывается." }, "SEARCH_TYPE": { "type": "string", "description": "| Тип уведомления в формате `MODULE` или ```MODULE|EVENT```, например `calendar` или ```calendar|change```. Коды типов возвращает метод im.notify.schema.get." }, "SEARCH_TYPES": { "type": "array", "items": {}, "description": "| Массив типов уведомлений, например `[\"calendar\", \"tasks\"]`." }, "SEARCH_DATE": { "type": "string", "format": "date-time", "description": "| Дата и время в формате RFC 3339, например `2026-11-10T00:00:00+03:00`. Метод найдет уведомления, созданные в течение 24 часов от этого момента." }, "SEARCH_DATE_FROM": { "type": "string", "format": "date-time", "description": "| Начало периода в формате RFC 3339. Передавайте вместе с `SEARCH_DATE_TO`." }, "SEARCH_DATE_TO": { "type": "string", "format": "date-time", "description": "| Конец периода в формате RFC 3339. Передавайте вместе с `SEARCH_DATE_FROM`. Метод добавляет к значению 24 часа: при `2026-11-10T00:00:00+03:00` в выборку попадут уведомления за 10 ноября ||" }, "SEARCH_AUTHORS": { "type": "array", "items": {}, "description": "| Массив идентификаторов авторов уведомлений, например `[1, 15]`. Значение `0` выбирает системные уведомления." }, "GROUP_TAG": { "type": "string", "description": "| Группа уведомлений для дополнительной фильтрации. Допустимые значения:" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор последнего уведомления на предыдущей странице — поле `id` последнего элемента массива `notifications`. Метод вернет уведомления с идентификатором меньше `LAST_ID`." }, "LIMIT": { "type": "integer", "description": "| Количество уведомлений на странице. По умолчанию — `50`, максимум — `50`. Большее значение метод уменьшает до `50`." }, "CONVERT_TEXT": { "type": "string", "description": "| Метод принимает параметр, но не учитывает его ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.personal.add": { "post": { "summary": "Отправить персональное уведомление im.notify.personal.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.personal.add` отправляет персональное уведомление от имени текущего пользователя.", "operationId": "im_notify_personal_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-personal-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений ||" }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений ||" }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read": { "post": { "summary": "Прочитать или вернуть непрочитанным уведомление im.notify.read", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.read` отмечает уведомления текущего пользователя как прочитанные или непрочитанные.", "operationId": "im_notify_read", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-read.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор уведомления. Получить идентификатор можно методом im.notify.get." }, "ACTION": { "type": "string", "description": "| Действие над уведомлениями:" }, "ONLY_CURRENT": { "type": "string", "description": "| Какие уведомления изменить:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор уведомления. Получить идентификатор можно методом im.notify.get." }, "ACTION": { "type": "string", "description": "| Действие над уведомлениями:" }, "ONLY_CURRENT": { "type": "string", "description": "| Какие уведомления изменить:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read.all": { "post": { "summary": "Прочитать все уведомления im.notify.read.all", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.read.all` отмечает все уведомления текущего пользователя как прочитанные.", "operationId": "im_notify_read_all", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-read-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read.list": { "post": { "summary": "Прочитать список уведомлений im.notify.read.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.read.list` отмечает список уведомлений как прочитанные или непрочитанные.", "operationId": "im_notify_read_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-read-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IDS": { "type": "string", "description": "| Массив идентификаторов уведомлений, например `[101, 102, 103]`. Получить идентификаторы можно методом im.notify.get." }, "ACTION": { "type": "string", "description": "| Действие над уведомлениями:" } }, "required": [ "IDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IDS": { "type": "string", "description": "| Массив идентификаторов уведомлений, например `[101, 102, 103]`. Получить идентификаторы можно методом im.notify.get." }, "ACTION": { "type": "string", "description": "| Действие над уведомлениями:" } }, "required": [ "IDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.schema.get": { "post": { "summary": "Получить схему типов уведомлений im.notify.schema.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.schema.get` возвращает типы уведомлений портала, сгруппированные по модулям.", "operationId": "im_notify_schema_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-schema-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.system.add": { "post": { "summary": "Отправить системное уведомление im.notify.system.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.notify.system.add` отправляет системное уведомление пользователю.", "operationId": "im_notify_system_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/notifications/im-notify-system-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений." }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты. При вызове из приложения первой строкой текста метод добавляет название приложения ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя уведомления. Получатель должен быть активным пользователем портала: если пользователь не найден или неактивен, метод вернет `result: false`." }, "MESSAGE": { "type": "string", "description": "| Текст уведомления. Метод удаляет пробелы по краям строки, строка из одних пробелов вызывает ошибку `MESSAGE_EMPTY`. Поддерживает BB-коды — подробнее в разделе Форматирование сообщений." }, "MESSAGE_OUT": { "type": "string", "description": "| Текст уведомления для внешних каналов, например, почты. При вызове из приложения первой строкой текста метод добавляет название приложения ||" }, "TAG": { "type": "string", "description": "| Тег уведомления. Если у получателя уже есть уведомление этого приложения с таким тегом, предыдущее уведомление удаляется." }, "SUB_TAG": { "type": "string", "description": "| Дополнительный тег уведомления без проверки уникальности. По тегам `TAG` и `SUB_TAG` уведомления можно удалить методом im.notify.delete." }, "ATTACH": { "type": "array", "items": {} } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.get": { "post": { "summary": "Получить сокращенный список последних чатов im.recent.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.recent.get` получает список последних чатов пользователя.", "operationId": "im_recent_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-recent-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропустить чаты открытых линий." }, "SKIP_CHAT": { "type": "string", "description": "| Пропустить групповые чаты." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропустить диалоги один-на-один." }, "LAST_UPDATE": { "type": "string", "format": "date-time", "description": "| Сделать выборку с указанной даты в формате ATOM (ISO-8601) ||" }, "ONLY_OPENLINES": { "type": "string", "description": "| Выбрать только чаты открытых линий." }, "LAST_SYNC_DATE": { "type": "string", "format": "date-time", "description": "| Дата предыдущей выборки в формате ATOM (ISO-8601) для загрузки изменений, которые произошли в списке с указанной даты." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропустить чаты открытых линий." }, "SKIP_CHAT": { "type": "string", "description": "| Пропустить групповые чаты." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропустить диалоги один-на-один." }, "LAST_UPDATE": { "type": "string", "format": "date-time", "description": "| Сделать выборку с указанной даты в формате ATOM (ISO-8601) ||" }, "ONLY_OPENLINES": { "type": "string", "description": "| Выбрать только чаты открытых линий." }, "LAST_SYNC_DATE": { "type": "string", "format": "date-time", "description": "| Дата предыдущей выборки в формате ATOM (ISO-8601) для загрузки изменений, которые произошли в списке с указанной даты." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.hide": { "post": { "summary": "Удалить чат из списка последних im.recent.hide", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.recent.hide` удаляет диалог из списка последних чатов текущего пользователя.", "operationId": "im_recent_hide", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/special-operations/im-recent-hide.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.list": { "post": { "summary": "Получить список чатов im.recent.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.recent.list` получает список последних диалогов пользователя с поддержкой пагинации.", "operationId": "im_recent_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-recent-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропускать чаты открытых линий." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропускать диалоги один-на-один." }, "SKIP_CHAT": { "type": "string", "description": "| Пропускать групповые чаты." }, "LAST_MESSAGE_DATE": { "type": "string", "format": "date-time", "description": "| Дата последнего элемента предыдущей выборки в формате ATOM (ISO-8601) ||" }, "UNREAD_ONLY": { "type": "string", "description": "| Возвращать только диалоги с непрочитанными сообщениями." }, "PARSE_TEXT": { "type": "string", "description": "| Парсить текст последнего сообщения." }, "GET_ORIGINAL_TEXT": { "type": "string", "description": "| Вернуть оригинальный текст сообщения без преобразований." }, "SKIP_UNDISTRIBUTED_OPENLINES": { "type": "string", "description": "| Пропускать нераспределенные чаты открытых линий." }, "ONLY_OPENLINES": { "type": "string", "description": "| Возвращать только чаты открытых линий." }, "ONLY_COPILOT": { "type": "string", "description": "| Возвращать только чаты BitrixGPT." }, "ONLY_CHANNEL": { "type": "string", "description": "| Возвращать только каналы." }, "CAN_MANAGE_MESSAGES": { "type": "string", "description": "| Возвращать только чаты с правом управления сообщениями." }, "OFFSET": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропускать чаты открытых линий." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропускать диалоги один-на-один." }, "SKIP_CHAT": { "type": "string", "description": "| Пропускать групповые чаты." }, "LAST_MESSAGE_DATE": { "type": "string", "format": "date-time", "description": "| Дата последнего элемента предыдущей выборки в формате ATOM (ISO-8601) ||" }, "UNREAD_ONLY": { "type": "string", "description": "| Возвращать только диалоги с непрочитанными сообщениями." }, "PARSE_TEXT": { "type": "string", "description": "| Парсить текст последнего сообщения." }, "GET_ORIGINAL_TEXT": { "type": "string", "description": "| Вернуть оригинальный текст сообщения без преобразований." }, "SKIP_UNDISTRIBUTED_OPENLINES": { "type": "string", "description": "| Пропускать нераспределенные чаты открытых линий." }, "ONLY_OPENLINES": { "type": "string", "description": "| Возвращать только чаты открытых линий." }, "ONLY_COPILOT": { "type": "string", "description": "| Возвращать только чаты BitrixGPT." }, "ONLY_CHANNEL": { "type": "string", "description": "| Возвращать только каналы." }, "CAN_MANAGE_MESSAGES": { "type": "string", "description": "| Возвращать только чаты с правом управления сообщениями." }, "OFFSET": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.pin": { "post": { "summary": "Закрепить чат вверху списка im.recent.pin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.recent.pin` закрепляет или открепляет диалог вверху списка чатов пользователя.", "operationId": "im_recent_pin", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/special-operations/im-recent-pin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "PIN": { "type": "string", "description": "| Закрепить или открепить диалог:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "PIN": { "type": "string", "description": "| Закрепить или открепить диалог:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.unread": { "post": { "summary": "Установить или снять признак «прочитано» у чата im.recent.unread", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.recent.unread` устанавливает или снимает признак «прочитано» у чата.", "operationId": "im_recent_unread", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/special-operations/im-recent-unread.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "ACTION": { "type": "string", "description": "| Действие с меткой «прочитано»:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор чата в формате:" }, "ACTION": { "type": "string", "description": "| Действие с меткой «прочитано»:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.revision.get": { "post": { "summary": "Получить ревизии API im.revision.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.revision.get` возвращает ревизии API [модуля IM](../../settings/cloud-and-on-premise/on-premise/versions.md) для текущего Битрикс24.", "operationId": "im_revision_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/im-revision-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.chat.list": { "post": { "summary": "Найти чаты im.search.chat.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.search.chat.list` выполняет поиск чатов, к которым текущий пользователь имеет доступ. Поиск выполняется по заголовку, имени и фамилии участников чата.", "operationId": "im_search_chat_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-chat-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза для поиска по индексируемым данным чата. Минимальное количество символов для поиска — `2` ||" }, "FIND_LINES": { "type": "string", "description": "| Поисковая фраза для поиска чатов среди Открытых линий. Минимальное количество символов для поиска — `2` ||" }, "OFFSET": { "type": "integer", "description": "| Смещение выборки чатов. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза для поиска по индексируемым данным чата. Минимальное количество символов для поиска — `2` ||" }, "FIND_LINES": { "type": "string", "description": "| Поисковая фраза для поиска чатов среди Открытых линий. Минимальное количество символов для поиска — `2` ||" }, "OFFSET": { "type": "integer", "description": "| Смещение выборки чатов. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.department.list": { "post": { "summary": "Найти подразделения im.search.department.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.search.department.list` выполняет поиск подразделений по полному названию.", "operationId": "im_search_department_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-department-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза для поиска по началу слов в полном названии подразделения (поле full_name)." }, "USER_DATA": { "type": "string", "description": "| Возвращать данные руководителя подразделения в поле manager_user_data." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки подразделений. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } }, "required": [ "FIND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза для поиска по началу слов в полном названии подразделения (поле full_name)." }, "USER_DATA": { "type": "string", "description": "| Возвращать данные руководителя подразделения в поле manager_user_data." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки подразделений. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } }, "required": [ "FIND" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.add": { "post": { "summary": "Добавить запись в историю поиска im.search.last.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод разработан для предыдущей версии чата и оставлен только для поддержки существующих интеграций. В текущей версии чата М1 он работает, но результат не отображается в интерфейсе. Замены в текущей версии нет.", "operationId": "im_search_last_add", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-last-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта для сообщений: пользователь или чат." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта для сообщений: пользователь или чат." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.delete": { "post": { "summary": "Удалить запись из истории поиска im.search.last.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод разработан для предыдущей версии чата и оставлен только для поддержки существующих интеграций. В текущей версии чата М1 он работает, но результат не отображается в интерфейсе. Замены в текущей версии нет.", "operationId": "im_search_last_delete", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-last-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта для сообщений: пользователь или чат." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта для сообщений: пользователь или чат." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.get": { "post": { "summary": "Получить историю поиска im.search.last.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод разработан для предыдущей версии чата и оставлен только для поддержки существующих интеграций. В текущей версии чата М1 он работает, но результат не отображается в интерфейсе. Замены в текущей версии нет.", "operationId": "im_search_last_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-last-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропустить чаты Открытых линий." }, "SKIP_CHAT": { "type": "string", "description": "| Пропустить групповые чаты." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропустить личные диалоги." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Пропустить чаты Открытых линий." }, "SKIP_CHAT": { "type": "string", "description": "| Пропустить групповые чаты." }, "SKIP_DIALOG": { "type": "string", "description": "| Пропустить личные диалоги." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.user.list": { "post": { "summary": "Найти пользователей im.search.user.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.search.user.list` выполняет поиск пользователей по имени, фамилии, должности и подразделению.", "operationId": "im_search_user_list", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/search/im-search-user-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза. Минимальное количество символов для поиска — `2` ||" }, "BUSINESS": { "type": "string", "description": "| Искать только среди бизнес-пользователей." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки пользователей. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } }, "required": [ "FIND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Поисковая фраза. Минимальное количество символов для поиска — `2` ||" }, "BUSINESS": { "type": "string", "description": "| Искать только среди бизнес-пользователей." }, "OFFSET": { "type": "integer", "description": "| Смещение выборки пользователей. По умолчанию `0` ||" }, "LIMIT": { "type": "integer", "description": "| Количество элементов в выборке. По умолчанию `10`. Максимальное значение `50` ||" } }, "required": [ "FIND" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.get": { "post": { "summary": "Получить данные о пользователе im.user.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.get` получает данные о текущем пользователе или о пользователе по `ID`.", "operationId": "im_user_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользователя. Если не передан, метод вернет данные текущего пользователя." }, "AVATAR_HR": { "type": "string", "description": "| Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользователя. Если не передан, метод вернет данные текущего пользователя." }, "AVATAR_HR": { "type": "string", "description": "| Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.list.get": { "post": { "summary": "Получить данные о списке пользователей im.user.list.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.list.get` возвращает данные о пользователях по списку идентификаторов.", "operationId": "im_user_list_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-list-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {} }, "AVATAR_HR": { "type": "string", "description": "| Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`." }, "RESULT_TYPE": { "type": "string", "description": "| Формат `result`. Значение `array` вернет обычный массив объектов пользователей, любое другое значение вернет объект с ключами-идентификаторами пользователей ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {} }, "AVATAR_HR": { "type": "string", "description": "| Параметр для запроса поля `avatar_hr` с адресом аватара в высоком разрешении. Допустимые значения: `Y` или `N`, по умолчанию `N`." }, "RESULT_TYPE": { "type": "string", "description": "| Формат `result`. Значение `array` вернет обычный массив объектов пользователей, любое другое значение вернет объект с ключами-идентификаторами пользователей ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.get": { "post": { "summary": "Получить статус пользователя im.user.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.status.get` возвращает статус текущего пользователя.", "operationId": "im_user_status_get", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.idle.end": { "post": { "summary": "Выключить автоматический статус «Отошел» im.user.status.idle.end", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.status.idle.end` выключает автоматический статус «Отошел» для текущего пользователя.", "operationId": "im_user_status_idle_end", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-status-idle-end.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.idle.start": { "post": { "summary": "Включить автоматический статус «Отошел» im.user.status.idle.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.status.idle.start` включает автоматический статус «Отошел» для текущего пользователя.", "operationId": "im_user_status_idle_start", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-status-idle-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "AGO": { "type": "integer", "description": "| Сколько минут назад установить статус \"Отошел\". Если параметр не передан, используется `10`. Минимальное значение `1` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "AGO": { "type": "integer", "description": "| Сколько минут назад установить статус \"Отошел\". Если параметр не передан, используется `10`. Минимальное значение `1` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.set": { "post": { "summary": "Установить статус пользователя im.user.status.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.user.status.set` устанавливает пользовательский статус текущего пользователя.", "operationId": "im_user_status_set", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/users/im-user-status-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "STATUS": { "type": "string", "description": "| Новый статус пользователя. Значение чувствительно к регистру и должно передаваться в нижнем регистре." } }, "required": [ "STATUS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "STATUS": { "type": "string", "description": "| Новый статус пользователя. Значение чувствительно к регистру и должно передаваться в нижнем регистре." } }, "required": [ "STATUS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2": { "post": { "summary": "Форматы событий im.v2", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Описание всех событий, которые приложение или пользователь получает через [im.v2.Event.get](./event-get.md).", "operationId": "im_v2", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/events/events.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "| `Message` | Отправленное сообщение. Описание полей объекта — Message ||" }, "chat": { "type": "string", "description": "| `Chat` | Чат, в котором отправлено сообщение. Описание полей объекта — Chat ||" }, "user": { "type": "string", "description": "| `User` | Автор сообщения. Описание полей объекта — User ||" }, "language": { "type": "string", "description": "| `string` | Язык Битрикс24 (например, `en`, `ru`) ||" }, "additionalMessages": { "type": "string", "description": "| `array` | Массив объектов `Message`. Если `message` — ответ на другое сообщение, в массиве — исходное сообщение, иначе массив пустой. Если исходное сообщение удалено, оно придет с текстом об удалении ||" }, "messageId": { "type": "string", "description": "| `integer` | ID удаленного сообщения ||" }, "reaction": { "type": "string", "description": "| `string` | Код реакции (например, `like`) ||" }, "action": { "type": "string", "description": "| `string` | Действие с реакцией. В событиях `im.v2` приходит пустой строкой и при добавлении, и при удалении реакции: по этому полю их не различить ||" }, "dialogId": { "type": "string", "description": "| `string` | ID диалога. Для группового чата — `chat` и ID чата, например `chat5`. Для личного — ID собеседника ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "| `Message` | Отправленное сообщение. Описание полей объекта — Message ||" }, "chat": { "type": "string", "description": "| `Chat` | Чат, в котором отправлено сообщение. Описание полей объекта — Chat ||" }, "user": { "type": "string", "description": "| `User` | Автор сообщения. Описание полей объекта — User ||" }, "language": { "type": "string", "description": "| `string` | Язык Битрикс24 (например, `en`, `ru`) ||" }, "additionalMessages": { "type": "string", "description": "| `array` | Массив объектов `Message`. Если `message` — ответ на другое сообщение, в массиве — исходное сообщение, иначе массив пустой. Если исходное сообщение удалено, оно придет с текстом об удалении ||" }, "messageId": { "type": "string", "description": "| `integer` | ID удаленного сообщения ||" }, "reaction": { "type": "string", "description": "| `string` | Код реакции (например, `like`) ||" }, "action": { "type": "string", "description": "| `string` | Действие с реакцией. В событиях `im.v2` приходит пустой строкой и при добавлении, и при удалении реакции: по этому полю их не различить ||" }, "dialogId": { "type": "string", "description": "| `string` | ID диалога. Для группового чата — `chat` и ID чата, например `chat5`. Для личного — ID собеседника ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.Event.get": { "post": { "summary": "Получить события пользователя im.v2.Event.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.v2.Event.get` возвращает события мессенджера для текущего пользователя, например новые сообщения и реакции. Приложение само периодически вызывает метод и забирает накопленные события — это режим polling.", "operationId": "im_v2_Event_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "description": "| Передавайте `nextOffset` из предыдущего ответа. Метод вернет события с ID от `offset`, а события с меньшим ID удалит из очереди как подтвержденные. Без параметра метод ничего не подтверждает. По умолчанию `0`, отрицательное значение метод считает нулем." }, "limit": { "type": "integer", "description": "| Максимальное количество возвращаемых событий (1–1000). По умолчанию `100`. Значение вне диапазона метод заменяет ближайшей границей ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "description": "| Передавайте `nextOffset` из предыдущего ответа. Метод вернет события с ID от `offset`, а события с меньшим ID удалит из очереди как подтвержденные. Без параметра метод ничего не подтверждает. По умолчанию `0`, отрицательное значение метод считает нулем." }, "limit": { "type": "integer", "description": "| Максимальное количество возвращаемых событий (1–1000). По умолчанию `100`. Значение вне диапазона метод заменяет ближайшей границей ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.Event.subscribe": { "post": { "summary": "Подписаться на события im.v2.Event.subscribe", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.v2.Event.subscribe` подписывает текущего пользователя на запись событий. После подписки новые события записываются в лог и становятся доступными через [im.v2.Event.get](./event-get.md). События, произошедшие до подписки, в лог не добавляются.", "operationId": "im_v2_Event_subscribe", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.Event.unsubscribe": { "post": { "summary": "Отписаться от событий im.v2.Event.unsubscribe", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.v2.Event.unsubscribe` отменяет подписку текущего пользователя на события мессенджера: Битрикс24 перестает записывать новые события и удаляет накопленные.", "operationId": "im_v2_Event_unsubscribe", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.File.download": { "post": { "summary": "Получить ссылку для скачивания файла im.v2.File.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.v2.File.download` возвращает ссылку для скачивания файла из чата.", "operationId": "im_v2_File_download", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fileId": { "type": "integer", "description": "| ID файла на Диске. Можно получить из ответа метода im.v2.File.upload ||" } }, "required": [ "dialogId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fileId": { "type": "integer", "description": "| ID файла на Диске. Можно получить из ответа метода im.v2.File.upload ||" } }, "required": [ "dialogId", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.File.upload": { "post": { "summary": "Загрузить файл в чат im.v2.File.upload", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `im.v2.File.upload` загружает файл в чат от имени текущего пользователя. Объединяет три шага устаревшего API в один вызов: загрузку файла на диск, прикрепление к чату и отправку сообщения.", "operationId": "im_v2_File_upload", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Объект с параметрами файла и сообщения (подробное описание) ||" }, "content": { "type": "string", "description": "| Содержимое файла в кодировке Base64. Максимальный размер файла после декодирования — 100 МБ ||" }, "message": { "type": "string", "description": "| Текст сообщения, отправляемого вместе с файлом ||" } }, "required": [ "dialogId", "fields", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Объект с параметрами файла и сообщения (подробное описание) ||" }, "content": { "type": "string", "description": "| Содержимое файла в кодировке Base64. Максимальный размер файла после декодирования — 100 МБ ||" }, "message": { "type": "string", "description": "| Текст сообщения, отправляемого вместе с файлом ||" } }, "required": [ "dialogId", "fields", "content" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/imbot.app.register": { "post": { "summary": "Зарегистрировать приложение для чата imbot.app.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.app.register` регистрирует приложение для чата.", "operationId": "imbot_app_register", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/outdated/create-app/imbot-app-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "string", "description": "| `62` | Идентификатор бота владельца приложения для чата ||" }, "CODE": { "type": "string", "description": "| `'echo'` | Код приложения для чата ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | Варианты для `JS_METHOD`:" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Иконка в base64." }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Контекст приложения." }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Доступна ли команда пользователям экстранет, по умолчанию N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Поддержка онлайн-чата ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно. ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Массив переводов, желательно указывать как минимум для RU и EN ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "string", "description": "| `62` | Идентификатор бота владельца приложения для чата ||" }, "CODE": { "type": "string", "description": "| `'echo'` | Код приложения для чата ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | Варианты для `JS_METHOD`:" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Иконка в base64." }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Контекст приложения." }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Доступна ли команда пользователям экстранет, по умолчанию N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Поддержка онлайн-чата ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно. ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Массив переводов, желательно указывать как минимум для RU и EN ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.app.unregister": { "post": { "summary": "Удалить приложение для чата imbot.app.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.app.unregister` удаляет приложение из чата.", "operationId": "imbot_app_unregister", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/outdated/create-app/imbot-app-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "APP_ID": { "type": "string", "description": "| `13` | Идентификатор команды для удаления ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "APP_ID": { "type": "string", "description": "| `13` | Идентификатор команды для удаления ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.app.update": { "post": { "summary": "Изменить данные о приложении в чате imbot.app.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.app.update` обновляет данные о приложении в чате.", "operationId": "imbot_app_update", "tags": [ "Чаты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chats/outdated/create-app/imbot-app-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "APP_ID": { "type": "string", "description": "| `13` | Идентификатор чата ||" }, "IFRAME": { "type": "string", "description": "| `'https://marta.bitrix24.tech/iframe/echo.php'` | URL адрес фрейма ||" }, "IFRAME_WIDTH": { "type": "string", "description": "| `'350'` | Желаемая ширина фрейма. Минимальное значение - 250px ||" }, "IFRAME_HEIGHT": { "type": "string", "description": "| `'150'` | Желаемая высота фрейма. Минимальное значение - 50px ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | ||" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "HASH": { "type": "string", "description": "| `'register'` | Токен для доступа к вашему фрейму, 32 символа ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Иконка вашего приложения - base64 ||" }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Контекст приложения ||" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Доступна ли команда пользователям экстранет, по умолчанию N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Поддержка онлайн-чата ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Массив переводов, желательно указывать как минимум для RU и EN ||" } }, "required": [ "APP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "APP_ID": { "type": "string", "description": "| `13` | Идентификатор чата ||" }, "IFRAME": { "type": "string", "description": "| `'https://marta.bitrix24.tech/iframe/echo.php'` | URL адрес фрейма ||" }, "IFRAME_WIDTH": { "type": "string", "description": "| `'350'` | Желаемая ширина фрейма. Минимальное значение - 250px ||" }, "IFRAME_HEIGHT": { "type": "string", "description": "| `'150'` | Желаемая высота фрейма. Минимальное значение - 50px ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | ||" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "HASH": { "type": "string", "description": "| `'register'` | Токен для доступа к вашему фрейму, 32 символа ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Иконка вашего приложения - base64 ||" }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Контекст приложения ||" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Доступна ли команда пользователям экстранет, по умолчанию N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Поддержка онлайн-чата ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Массив переводов, желательно указывать как минимум для RU и EN ||" } }, "required": [ "APP_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.bot.list": { "post": { "summary": "Получить список чат-ботов imbot.bot.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Bot.list](../../chat-bots-v2/imbot.v2/bots/bot-list.md).", "operationId": "imbot_bot_list", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/bots/imbot-bot-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект, где ключ верхнего уровня равен `BOT_ID`, а значение содержит данные бота. Структура элемента подробно описана ниже ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор чат-бота ||" }, "CODE": { "type": "string", "description": "| Код чат-бота ||" }, "OPENLINE": { "type": "string", "description": "| Признак поддержки открытых линий: `Y` или `N` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Объект, где ключ верхнего уровня равен `BOT_ID`, а значение содержит данные бота. Структура элемента подробно описана ниже ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" }, "ID": { "type": "integer", "description": "| Идентификатор чат-бота ||" }, "CODE": { "type": "string", "description": "| Код чат-бота ||" }, "OPENLINE": { "type": "string", "description": "| Признак поддержки открытых линий: `Y` или `N` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.add": { "post": { "summary": "Создать чат от лица чат-бота imbot.chat.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.add](../../chat-bots-v2/imbot.v2/chats/chat-add.md).", "operationId": "imbot_chat_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Тип чата. Возможные значения:" }, "TITLE": { "type": "string", "description": "| Заголовок чата ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание чата ||" }, "COLOR": { "type": "string", "description": "| Цвет чата для мобильного приложения. Возможные значения:" }, "MESSAGE": { "type": "string", "description": "| Приветственное сообщение в чате ||" }, "USERS": { "type": "array", "items": {}, "description": "| Массив участников чата ||" }, "AVATAR": { "type": "string", "description": "| Аватар чата в формате Base64." }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для привязки чата к внешнему контексту ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Тип чата. Возможные значения:" }, "TITLE": { "type": "string", "description": "| Заголовок чата ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание чата ||" }, "COLOR": { "type": "string", "description": "| Цвет чата для мобильного приложения. Возможные значения:" }, "MESSAGE": { "type": "string", "description": "| Приветственное сообщение в чате ||" }, "USERS": { "type": "array", "items": {}, "description": "| Массив участников чата ||" }, "AVATAR": { "type": "string", "description": "| Аватар чата в формате Base64." }, "ENTITY_TYPE": { "type": "string", "description": "| Тип объекта для привязки чата к внешнему контексту ||" }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор объекта в рамках `ENTITY_TYPE`." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.get": { "post": { "summary": "Получить идентификатор чата imbot.chat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md).", "operationId": "imbot_chat_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип внешнего объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор внешнего объекта." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Тип внешнего объекта." }, "ENTITY_ID": { "type": "string", "description": "| Идентификатор внешнего объекта." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.leave": { "post": { "summary": "Выход чат-бота из указанного чата imbot.chat.leave", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.leave](../../chat-bots-v2/imbot.v2/chats/chat-leave.md).", "operationId": "imbot_chat_leave", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-leave.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.sendTyping": { "post": { "summary": "Отправить признак «Чат-бот пишет» imbot.chat.sendTyping", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.InputAction.notify](../../chat-bots-v2/imbot.v2/ui/chat-input-action-notify.md).", "operationId": "imbot_chat_sendTyping", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта, который получит сообщение: пользователь или чат." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта, который получит сообщение: пользователь или чат." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.setManager": { "post": { "summary": "Назначить или снять права администратора чата imbot.chat.setManager", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Для назначения и снятия прав администратора используйте методы [imbot.v2.Chat.Manager.add](../../chat-bots-v2/imbot.v2/chats/chat-manager-add.md) и [imbot.v2.Chat.Manager.delete](../../chat-bots-v2/imbot.v2/chats/chat-manager-delete.md).", "operationId": "imbot_chat_setManager", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-set-manager.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого меняется признак администратора." }, "IS_MANAGER": { "type": "string", "description": "| Признак администратора. Возможные значения:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого меняется признак администратора." }, "IS_MANAGER": { "type": "string", "description": "| Признак администратора. Возможные значения:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.setOwner": { "post": { "summary": "Сменить владельца чата от лица чат-бота imbot.chat.setOwner", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.setOwner](../../chat-bots-v2/imbot.v2/chats/chat-set-owner.md).", "operationId": "imbot_chat_setOwner", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор нового владельца чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Технический параметр для сценариев без `clientId` в авторизации." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор нового владельца чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Технический параметр для сценариев без `clientId` в авторизации." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateAvatar": { "post": { "summary": "Изменить аватар чата imbot.chat.updateAvatar", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md).", "operationId": "imbot_chat_updateAvatar", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-update-avatar.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "AVATAR": { "type": "string", "description": "| Изображение в формате Base64." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "AVATAR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "AVATAR": { "type": "string", "description": "| Изображение в формате Base64." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "AVATAR" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateColor": { "post": { "summary": "Изменить цвет чата imbot.chat.updateColor", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md).", "operationId": "imbot_chat_updateColor", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-update-color.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "COLOR": { "type": "string", "description": "| Цвет чата для мобильного приложения. Возможные значения:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "COLOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "COLOR": { "type": "string", "description": "| Цвет чата для мобильного приложения. Возможные значения:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "COLOR" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateTitle": { "post": { "summary": "Изменить заголовок чата imbot.chat.updateTitle", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md).", "operationId": "imbot_chat_updateTitle", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-update-title.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "TITLE": { "type": "string", "description": "| Новый заголовок чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "TITLE": { "type": "string", "description": "| Новый заголовок чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.add": { "post": { "summary": "Добавить участников чата imbot.chat.user.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.User.add](../../chat-bots-v2/imbot.v2/chats/chat-user-add.md).", "operationId": "imbot_chat_user_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-user-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей для добавления." }, "HIDE_HISTORY": { "type": "string", "description": "| Скрыть историю чата для добавляемых пользователей:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USERS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей для добавления." }, "HIDE_HISTORY": { "type": "string", "description": "| Скрыть историю чата для добавляемых пользователей:" }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USERS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.delete": { "post": { "summary": "Исключить участников из чата imbot.chat.user.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.User.delete](../../chat-bots-v2/imbot.v2/chats/chat-user-delete.md).", "operationId": "imbot_chat_user_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-user-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которого нужно удалить из чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, которого нужно удалить из чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.list": { "post": { "summary": "Получить список участников чата imbot.chat.user.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.User.list](../../chat-bots-v2/imbot.v2/chats/chat-user-list.md).", "operationId": "imbot_chat_user_list", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-chat-user-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." }, "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.answer": { "post": { "summary": "Отправить ответ на команду imbot.command.answer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Command.answer](../../chat-bots-v2/imbot.v2/commands/command-answer.md).", "operationId": "imbot_command_answer", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/commands/imbot-command-answer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды. Обязателен, если не передан `COMMAND` ||" }, "COMMAND": { "type": "string", "description": "| Текст команды. Обязателен, если не передан `COMMAND_ID` ||" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, на которое отправляется ответ." }, "MESSAGE": { "type": "string", "description": "| Текст ответа ||" }, "ATTACH": { "type": "object", "description": "| Объект с вложением к сообщению. Минимальный формат:" }, "KEYBOARD": { "type": "object", "description": "| Клавиатура сообщения. Минимальный формат:" }, "MENU": { "type": "object", "description": "| Контекстное меню сообщения. Минимальный формат:" }, "SYSTEM": { "type": "string", "description": "| Тип сообщения:" }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки:" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "COMMAND_ID", "COMMAND", "MESSAGE_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды. Обязателен, если не передан `COMMAND` ||" }, "COMMAND": { "type": "string", "description": "| Текст команды. Обязателен, если не передан `COMMAND_ID` ||" }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, на которое отправляется ответ." }, "MESSAGE": { "type": "string", "description": "| Текст ответа ||" }, "ATTACH": { "type": "object", "description": "| Объект с вложением к сообщению. Минимальный формат:" }, "KEYBOARD": { "type": "object", "description": "| Клавиатура сообщения. Минимальный формат:" }, "MENU": { "type": "object", "description": "| Контекстное меню сообщения. Минимальный формат:" }, "SYSTEM": { "type": "string", "description": "| Тип сообщения:" }, "URL_PREVIEW": { "type": "string", "description": "| Преобразование ссылок в rich-ссылки:" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "COMMAND_ID", "COMMAND", "MESSAGE_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.register": { "post": { "summary": "Добавить команду imbot.command.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Command.register](../../chat-bots-v2/imbot.v2/commands/command-register.md).", "operationId": "imbot_command_register", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/commands/imbot-command-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list ||" }, "COMMAND": { "type": "string", "description": "| Текст команды, которую пользователь вводит в чате. Можно использовать латинские буквы и цифры без пробелов и специальных символов ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL обработчика события ONIMCOMMANDADD, который вызывается при использовании команды ||" }, "LANG": { "type": "array", "items": {}, "description": "| Массив локализаций команды. Структура описана ниже ||" }, "COMMON": { "type": "string", "description": "| Доступность команды:" }, "HIDDEN": { "type": "string", "description": "| Видимость команды:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Доступность команды пользователям экстранета:" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Идентификатор языка, например `ru` или `en` ||" }, "TITLE": { "type": "string", "description": "| Название команды на выбранном языке ||" }, "PARAMS": { "type": "string", "description": "| Подсказка по параметрам команды на выбранном языке ||" } }, "required": [ "BOT_ID", "COMMAND", "EVENT_COMMAND_ADD", "LANG", "LANGUAGE_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list ||" }, "COMMAND": { "type": "string", "description": "| Текст команды, которую пользователь вводит в чате. Можно использовать латинские буквы и цифры без пробелов и специальных символов ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL обработчика события ONIMCOMMANDADD, который вызывается при использовании команды ||" }, "LANG": { "type": "array", "items": {}, "description": "| Массив локализаций команды. Структура описана ниже ||" }, "COMMON": { "type": "string", "description": "| Доступность команды:" }, "HIDDEN": { "type": "string", "description": "| Видимость команды:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Доступность команды пользователям экстранета:" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Идентификатор языка, например `ru` или `en` ||" }, "TITLE": { "type": "string", "description": "| Название команды на выбранном языке ||" }, "PARAMS": { "type": "string", "description": "| Подсказка по параметрам команды на выбранном языке ||" } }, "required": [ "BOT_ID", "COMMAND", "EVENT_COMMAND_ADD", "LANG", "LANGUAGE_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.unregister": { "post": { "summary": "Удалить команду imbot.command.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Command.unregister](../../chat-bots-v2/imbot.v2/commands/command-unregister.md).", "operationId": "imbot_command_unregister", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/commands/imbot-command-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды для удаления ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "COMMAND_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды для удаления ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "COMMAND_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.update": { "post": { "summary": "Обновить команду imbot.command.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Command.update](../../chat-bots-v2/imbot.v2/commands/command-update.md).", "operationId": "imbot_command_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/commands/imbot-command-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды для обновления ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями для обновления. Структура описана ниже ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "COMMAND": { "type": "string", "description": "| Текст команды ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL обработчика события ONIMCOMMANDADD ||" }, "HIDDEN": { "type": "string", "description": "| Видимость команды:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Доступность для пользователей экстранета:" }, "LANG": { "type": "array", "items": {}, "description": "| Массив локализаций команды. Структура описана ниже ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Идентификатор языка, например `ru` или `en` ||" }, "TITLE": { "type": "string", "description": "| Название команды на выбранном языке ||" }, "PARAMS": { "type": "string", "description": "| Подсказка по параметрам команды на выбранном языке ||" } }, "required": [ "COMMAND_ID", "FIELDS", "LANGUAGE_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Идентификатор команды для обновления ||" }, "FIELDS": { "type": "object", "description": "| Объект с полями для обновления. Структура описана ниже ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "COMMAND": { "type": "string", "description": "| Текст команды ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL обработчика события ONIMCOMMANDADD ||" }, "HIDDEN": { "type": "string", "description": "| Видимость команды:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Доступность для пользователей экстранета:" }, "LANG": { "type": "array", "items": {}, "description": "| Массив локализаций команды. Структура описана ниже ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Идентификатор языка, например `ru` или `en` ||" }, "TITLE": { "type": "string", "description": "| Название команды на выбранном языке ||" }, "PARAMS": { "type": "string", "description": "| Подсказка по параметрам команды на выбранном языке ||" } }, "required": [ "COMMAND_ID", "FIELDS", "LANGUAGE_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.dialog.get": { "post": { "summary": "Получить данные о чате imbot.dialog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md).", "operationId": "imbot_dialog_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/chats/imbot-dialog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.add": { "post": { "summary": "Отправить сообщение imbot.message.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.Message.send](../../chat-bots-v2/imbot.v2/messages/chat-message-send.md).", "operationId": "imbot_message_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/messages/imbot-message-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта, который получит сообщение: пользователь или чат." }, "FROM_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-отправителя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search." }, "TO_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения. Метод автоматически убирает пробелы и переносы по краям текста сообщения ||" }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Признак системного сообщения." }, "URL_PREVIEW": { "type": "string", "description": "| Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Пропустить отправку сообщения во внешние коннекторы открытых линий." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор объекта, который получит сообщение: пользователь или чат." }, "FROM_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-отправителя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search." }, "TO_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя-получателя для отправки в приватный диалог. Получить идентификатор пользователя можно с помощью user.get и user.search." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения. Метод автоматически убирает пробелы и переносы по краям текста сообщения ||" }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Признак системного сообщения." }, "URL_PREVIEW": { "type": "string", "description": "| Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Пропустить отправку сообщения во внешние коннекторы открытых линий." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.delete": { "post": { "summary": "Удалить сообщение imbot.message.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.Message.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-delete.md).", "operationId": "imbot_message_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/messages/imbot-message-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения для удаления. Значение должно быть больше `0`." }, "COMPLETE": { "type": "string", "description": "| Режим удаления." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения для удаления. Значение должно быть больше `0`." }, "COMPLETE": { "type": "string", "description": "| Режим удаления." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.like": { "post": { "summary": "Установить «Мне нравится» для сообщения imbot.message.like", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте методы [imbot.v2.Chat.Message.Reaction.add](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.md) и [imbot.v2.Chat.Message.Reaction.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.md).", "operationId": "imbot_message_like", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/messages/imbot-message-like.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения в личных диалогах или в групповых чатах, где присутствует чат-бот. Значение должно быть больше `0`." }, "ACTION": { "type": "string", "description": "| Действие с реакцией на сообщение." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения в личных диалогах или в групповых чатах, где присутствует чат-бот. Значение должно быть больше `0`." }, "ACTION": { "type": "string", "description": "| Действие с реакцией на сообщение." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.update": { "post": { "summary": "Изменить отправленное сообщение imbot.message.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Chat.Message.update](../../chat-bots-v2/imbot.v2/messages/chat-message-update.md).", "operationId": "imbot_message_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/messages/imbot-message-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить можно методом imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно изменить. Значение должно быть больше `0`." }, "MESSAGE": { "type": "string", "description": "| Новый текст сообщения. Если передать пустое значение, сообщение будет удалено." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Пропускает отправку сообщения во внешние коннекторы открытых линий при обновлении `MESSAGE`." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить можно методом imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно изменить. Значение должно быть больше `0`." }, "MESSAGE": { "type": "string", "description": "| Новый текст сообщения. Если передать пустое значение, сообщение будет удалено." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Пропускает отправку сообщения во внешние коннекторы открытых линий при обновлении `MESSAGE`." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.register": { "post": { "summary": "Создать чат-бота imbot.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Bot.register](../../chat-bots-v2/imbot.v2/bots/bot-register.md).", "operationId": "imbot_register", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/bots/imbot-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Строковый код бота, уникальный в рамках Битрикс24 ||" }, "TYPE": { "type": "string", "description": "| Тип бота." }, "OPENLINE": { "type": "string", "description": "| Режим работы с Открытыми линиями." }, "EVENT_HANDLER": { "type": "string", "description": "| Общий URL обработчика событий. Если передан, его значение копируется в `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEUPDATE." }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEDELETE." }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL обработчика события ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTDELETE ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передайте уникальный CLIENT_ID — этот ключ будет привязан к чат-боту и потребуется для всех последующих вызовов imbot* через вебхук ||" }, "PROPERTIES": { "type": "object", "description": "| Свойства профиля чат-бота. Структура объекта подробно описана ниже ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия чат-бота. Обязательно передать `NAME` или `LAST_NAME` ||" }, "COLOR": { "type": "string", "description": "| Цвет чат-бота для мобильного интерфейса: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| День рождения в формате `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность или описание чат-бота ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Ссылка на сайт ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Пол, допустимые значения: `M` или `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Аватар чат-бота в формате Base64" } }, "required": [ "CODE", "EVENT_MESSAGE_ADD", "EVENT_WELCOME_MESSAGE", "EVENT_BOT_DELETE", "PROPERTIES", "LAST_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Строковый код бота, уникальный в рамках Битрикс24 ||" }, "TYPE": { "type": "string", "description": "| Тип бота." }, "OPENLINE": { "type": "string", "description": "| Режим работы с Открытыми линиями." }, "EVENT_HANDLER": { "type": "string", "description": "| Общий URL обработчика событий. Если передан, его значение копируется в `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEUPDATE." }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEDELETE." }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL обработчика события ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTDELETE ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передайте уникальный CLIENT_ID — этот ключ будет привязан к чат-боту и потребуется для всех последующих вызовов imbot* через вебхук ||" }, "PROPERTIES": { "type": "object", "description": "| Свойства профиля чат-бота. Структура объекта подробно описана ниже ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия чат-бота. Обязательно передать `NAME` или `LAST_NAME` ||" }, "COLOR": { "type": "string", "description": "| Цвет чат-бота для мобильного интерфейса: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| День рождения в формате `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность или описание чат-бота ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Ссылка на сайт ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Пол, допустимые значения: `M` или `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Аватар чат-бота в формате Base64" } }, "required": [ "CODE", "EVENT_MESSAGE_ADD", "EVENT_WELCOME_MESSAGE", "EVENT_BOT_DELETE", "PROPERTIES", "LAST_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.unregister": { "post": { "summary": "Удалить чат-бота imbot.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Bot.unregister](../../chat-bots-v2/imbot.v2/bots/bot-unregister.md).", "operationId": "imbot_unregister", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/bots/imbot-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Значение должно быть больше `0`." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "BOT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Значение должно быть больше `0`." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" } }, "required": [ "BOT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.update": { "post": { "summary": "Обновить чат-бота imbot.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [imbot.v2.Bot.update](../../chat-bots-v2/imbot.v2/bots/bot-update.md).", "operationId": "imbot_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/outdated/bots/imbot-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор можно методом imbot.bot.list. Значение должно быть больше `0` ||" }, "FIELDS": { "type": "object", "description": "| Данные для обновления чат-бота. Структура объекта подробно описана ниже ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "CODE": { "type": "string", "description": "| Новый строковый код бота, уникальный в рамках Битрикс24 ||" }, "EVENT_HANDLER": { "type": "string", "description": "| Общий URL обработчика событий. Если передан, его значение копируется в `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEUPDATE ||" }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEDELETE ||" }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL обработчика события ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTDELETE ||" }, "PROPERTIES": { "type": "object", "description": "| Свойства профиля чат-бота. Структура объекта подробно описана ниже ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия чат-бота. Если переданы оба значения: `NAME` и `LAST_NAME`, они не должны быть пустыми одновременно ||" }, "COLOR": { "type": "string", "description": "| Цвет чат-бота для мобильного интерфейса: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| День рождения в формате `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность или описание чат-бота ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Ссылка на сайт ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Пол, допустимые значения: `M` или `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Аватар чат-бота в формате Base64" } }, "required": [ "BOT_ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота. Получить идентификатор можно методом imbot.bot.list. Значение должно быть больше `0` ||" }, "FIELDS": { "type": "object", "description": "| Данные для обновления чат-бота. Структура объекта подробно описана ниже ||" }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота ||" }, "CODE": { "type": "string", "description": "| Новый строковый код бота, уникальный в рамках Битрикс24 ||" }, "EVENT_HANDLER": { "type": "string", "description": "| Общий URL обработчика событий. Если передан, его значение копируется в `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEUPDATE ||" }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTMESSAGEDELETE ||" }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL обработчика события ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL обработчика события ONIMBOTDELETE ||" }, "PROPERTIES": { "type": "object", "description": "| Свойства профиля чат-бота. Структура объекта подробно описана ниже ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия чат-бота. Если переданы оба значения: `NAME` и `LAST_NAME`, они не должны быть пустыми одновременно ||" }, "COLOR": { "type": "string", "description": "| Цвет чат-бота для мобильного интерфейса: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| День рождения в формате `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность или описание чат-бота ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Ссылка на сайт ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Пол, допустимые значения: `M` или `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Аватар чат-бота в формате Base64" } }, "required": [ "BOT_ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2": { "post": { "summary": "Журнал изменений API imbot.v2", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации История изменений API `imbot.v2`: новые возможности, исправления и изменения с потерей обратной совместимости. Записи расположены от новых к старым и сгруппированы по ревизиям REST API. Ревизию конкретного Битрикс24 возвращает метод [imbot.v2.Revision.get](./imbot.v2/revision-get.md) в поле `rest`: изменения из ревизий с большим номером на этом Битрикс24 еще недоступны.", "operationId": "imbot_v2", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/change-log.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/imbot.v2.Bot.get": { "post": { "summary": "Получить информацию о боте imbot.v2.Bot.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Bot.get` возвращает информацию о боте. Используется для проверки установки бота.", "operationId": "imbot_v2_Bot_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота из поля `result.bot.id` ответа imbot.v2.Bot.register. Обязателен, если не указан `code` ||" }, "code": { "type": "string", "description": "| Код бота. Обязателен, если не указан `botId` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота из поля `result.bot.id` ответа imbot.v2.Bot.register. Обязателен, если не указан `code` ||" }, "code": { "type": "string", "description": "| Код бота. Обязателен, если не указан `botId` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.list": { "post": { "summary": "Список ботов приложения imbot.v2.Bot.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Bot.list` возвращает список ботов текущего приложения в расширенном формате. При вызове через вебхук — ботов, зарегистрированных с переданным `botToken`. Он заменяет метод [imbot.bot.list](../../../outdated/bots/imbot-bot-list.md) первой версии API, соответствие параметров — в [таблице миграции](../../migration.md#metody).", "operationId": "imbot_v2_Bot_list", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "filter": { "type": "object", "description": "| Фильтр результатов." }, "limit": { "type": "integer", "description": "| Количество ботов на страницу. По умолчанию `50`. Со значением `0` или меньше метод вернет всех ботов приложения ||" }, "offset": { "type": "integer", "description": "| Смещение для пагинации. По умолчанию `0`. Чтобы получить следующую страницу, увеличьте `offset` на `limit`, пока в ответе `hasNextPage` равно `true`. Отрицательное значение вызывает ошибку ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "filter": { "type": "object", "description": "| Фильтр результатов." }, "limit": { "type": "integer", "description": "| Количество ботов на страницу. По умолчанию `50`. Со значением `0` или меньше метод вернет всех ботов приложения ||" }, "offset": { "type": "integer", "description": "| Смещение для пагинации. По умолчанию `0`. Чтобы получить следующую страницу, увеличьте `offset` на `limit`, пока в ответе `hasNextPage` равно `true`. Отрицательное значение вызывает ошибку ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.register": { "post": { "summary": "Зарегистрировать бота imbot.v2.Bot.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Bot.register` регистрирует нового чат-бота.", "operationId": "imbot_v2_Bot_register", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами бота. Описание параметров — ниже ||" }, "code": { "type": "string", "description": "| Уникальный код бота в рамках приложения ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "properties": { "type": "object", "description": "| Свойства профиля бота. Описание параметров — ниже ||" }, "type": { "type": "string", "description": "| Тип бота. Описание типов и их поведения — Типы ботов." }, "eventMode": { "type": "string", "description": "| Режим доставки событий." }, "webhookUrl": { "type": "string", "description": "| URL обработчика событий бота. Обязателен при `eventMode = webhook` ||" }, "isHidden": { "type": "boolean", "description": "| Скрытый бот. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Включить поддержку реакций. Допустимые значения: `true`, `false`. По умолчанию `true` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Включить поддержку Открытых линий. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "backgroundId": { "type": "string", "description": "| Фон чата бота. По умолчанию `null` — используется фон из настроек пользователя. Доступные значения — в таблице фонов. Невалидное значение нормализуется в `null` ||" }, "lastName": { "type": "string", "description": "| Фамилия бота ||" }, "workPosition": { "type": "string", "description": "| Должность бота (отображается в профиле) ||" }, "color": { "type": "string", "description": "| Цвет аватара, доступные цвета." }, "gender": { "type": "string", "description": "| Пол. Допустимые значения: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Аватар. Передавайте строку Base64 без префикса `data:*/*;base64,`." }, "ID": { "type": "string", "description": "| Тема | Цвет ||" } }, "required": [ "fields", "code", "properties" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами бота. Описание параметров — ниже ||" }, "code": { "type": "string", "description": "| Уникальный код бота в рамках приложения ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "properties": { "type": "object", "description": "| Свойства профиля бота. Описание параметров — ниже ||" }, "type": { "type": "string", "description": "| Тип бота. Описание типов и их поведения — Типы ботов." }, "eventMode": { "type": "string", "description": "| Режим доставки событий." }, "webhookUrl": { "type": "string", "description": "| URL обработчика событий бота. Обязателен при `eventMode = webhook` ||" }, "isHidden": { "type": "boolean", "description": "| Скрытый бот. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Включить поддержку реакций. Допустимые значения: `true`, `false`. По умолчанию `true` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Включить поддержку Открытых линий. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "backgroundId": { "type": "string", "description": "| Фон чата бота. По умолчанию `null` — используется фон из настроек пользователя. Доступные значения — в таблице фонов. Невалидное значение нормализуется в `null` ||" }, "lastName": { "type": "string", "description": "| Фамилия бота ||" }, "workPosition": { "type": "string", "description": "| Должность бота (отображается в профиле) ||" }, "color": { "type": "string", "description": "| Цвет аватара, доступные цвета." }, "gender": { "type": "string", "description": "| Пол. Допустимые значения: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Аватар. Передавайте строку Base64 без префикса `data:*/*;base64,`." }, "ID": { "type": "string", "description": "| Тема | Цвет ||" } }, "required": [ "fields", "code", "properties" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.unregister": { "post": { "summary": "Удалить бота imbot.v2.Bot.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Bot.unregister` удаляет бота. Он заменяет метод [imbot.unregister](../../../outdated/bots/imbot-unregister.md) первой версии API, соответствие параметров — в [таблице миграции](../../migration.md#metody).", "operationId": "imbot_v2_Bot_unregister", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота. Его возвращает метод imbot.v2.Bot.register в поле `result.bot.id` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота. Его возвращает метод imbot.v2.Bot.register в поле `result.bot.id` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.update": { "post": { "summary": "Обновить бота imbot.v2.Bot.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Bot.update` обновляет свойства бота. Он заменяет метод [imbot.update](../../../outdated/bots/imbot-update.md) первой версии API, соответствие параметров — в [таблице миграции](../../migration.md#metody).", "operationId": "imbot_v2_Bot_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота. Его возвращает метод imbot.v2.Bot.register в поле `result.bot.id` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fields": { "type": "object", "description": "| Обновляемые поля. Структура объекта описана ниже ||" }, "properties": { "type": "object", "description": "| Свойства профиля бота. Описание параметров — ниже ||" }, "isHidden": { "type": "boolean", "description": "| Скрытый бот. Допустимые значения: `true`, `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Поддержка реакций. Допустимые значения: `true`, `false` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Поддержка Открытых линий. Допустимые значения: `true`, `false` ||" }, "backgroundId": { "type": "string", "description": "| Фон чата бота. Передайте `null` для сброса на фон пользователя. Доступные значения — в таблице фонов. Невалидное значение нормализуется в `null` ||" }, "eventMode": { "type": "string", "description": "| Режим доставки событий: `fetch` или `webhook` ||" }, "webhookUrl": { "type": "string", "description": "| URL обработчика событий (применяется при `eventMode = webhook`) ||" }, "lastName": { "type": "string", "description": "| Фамилия бота ||" }, "workPosition": { "type": "string", "description": "| Должность бота (отображается в профиле) ||" }, "color": { "type": "string", "description": "| Цвет аватара, доступные цвета." }, "gender": { "type": "string", "description": "| Пол. Допустимые значения: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Аватар. Передавайте строку Base64 без префикса `data:*/*;base64,`." } }, "required": [ "botId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота. Его возвращает метод imbot.v2.Bot.register в поле `result.bot.id` ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fields": { "type": "object", "description": "| Обновляемые поля. Структура объекта описана ниже ||" }, "properties": { "type": "object", "description": "| Свойства профиля бота. Описание параметров — ниже ||" }, "isHidden": { "type": "boolean", "description": "| Скрытый бот. Допустимые значения: `true`, `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Поддержка реакций. Допустимые значения: `true`, `false` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Поддержка Открытых линий. Допустимые значения: `true`, `false` ||" }, "backgroundId": { "type": "string", "description": "| Фон чата бота. Передайте `null` для сброса на фон пользователя. Доступные значения — в таблице фонов. Невалидное значение нормализуется в `null` ||" }, "eventMode": { "type": "string", "description": "| Режим доставки событий: `fetch` или `webhook` ||" }, "webhookUrl": { "type": "string", "description": "| URL обработчика событий (применяется при `eventMode = webhook`) ||" }, "lastName": { "type": "string", "description": "| Фамилия бота ||" }, "workPosition": { "type": "string", "description": "| Должность бота (отображается в профиле) ||" }, "color": { "type": "string", "description": "| Цвет аватара, доступные цвета." }, "gender": { "type": "string", "description": "| Пол. Допустимые значения: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Аватар. Передавайте строку Base64 без префикса `data:*/*;base64,`." } }, "required": [ "botId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.InputAction.notify": { "post": { "summary": "Отправить индикатор действия бота imbot.v2.Chat.InputAction.notify", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.InputAction.notify` отправляет индикатор действия бота в чат — например, «бот печатает».", "operationId": "imbot_v2_Chat_InputAction_notify", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "statusMessageCode": { "type": "string", "description": "| Код статуса действия. Список доступных кодов описан ниже. Если не указан, отображается стандартный индикатор «печатает» ||" }, "duration": { "type": "integer", "description": "| Длительность отображения индикатора в секундах (1–600). По умолчанию определяется сервером ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "statusMessageCode": { "type": "string", "description": "| Код статуса действия. Список доступных кодов описан ниже. Если не указан, отображается стандартный индикатор «печатает» ||" }, "duration": { "type": "integer", "description": "| Длительность отображения индикатора в секундах (1–600). По умолчанию определяется сервером ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Manager.add": { "post": { "summary": "Добавить менеджеров чата imbot.v2.Chat.Manager.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Manager.add` добавляет пользователей к текущему списку менеджеров чата.", "operationId": "imbot_v2_Chat_Manager_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для назначения менеджерами ||" } }, "required": [ "botId", "dialogId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для назначения менеджерами ||" } }, "required": [ "botId", "dialogId", "userIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Manager.delete": { "post": { "summary": "Удалить менеджеров чата imbot.v2.Chat.Manager.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Manager.delete` удаляет пользователей из списка менеджеров чата.", "operationId": "imbot_v2_Chat_Manager_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для снятия роли менеджера ||" } }, "required": [ "botId", "dialogId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для снятия роли менеджера ||" } }, "required": [ "botId", "dialogId", "userIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.Reaction.add": { "post": { "summary": "Добавить реакцию на сообщение imbot.v2.Chat.Message.Reaction.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.Reaction.add` добавляет реакцию бота на сообщение.", "operationId": "imbot_v2_Chat_Message_Reaction_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения ||" }, "reaction": { "type": "string", "description": "| Код реакции. Список доступных кодов описан ниже ||" } }, "required": [ "botId", "messageId", "reaction" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения ||" }, "reaction": { "type": "string", "description": "| Код реакции. Список доступных кодов описан ниже ||" } }, "required": [ "botId", "messageId", "reaction" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.Reaction.delete": { "post": { "summary": "Удалить реакцию с сообщения imbot.v2.Chat.Message.Reaction.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.Reaction.delete` удаляет реакцию бота с сообщения.", "operationId": "imbot_v2_Chat_Message_Reaction_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения ||" }, "reaction": { "type": "string", "description": "| Код реакции для удаления. Список доступных кодов: imbot.v2.Chat.Message.Reaction.add ||" } }, "required": [ "botId", "messageId", "reaction" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения ||" }, "reaction": { "type": "string", "description": "| Код реакции для удаления. Список доступных кодов: imbot.v2.Chat.Message.Reaction.add ||" } }, "required": [ "botId", "messageId", "reaction" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.delete": { "post": { "summary": "Удалить сообщение imbot.v2.Chat.Message.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.delete` удаляет сообщение. Бот может удалить свои сообщения. Если бот является администратором чата — может удалить любое сообщение.", "operationId": "imbot_v2_Chat_Message_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID удаляемого сообщения ||" }, "complete": { "type": "boolean", "description": "| Полное удаление из базы данных. Допустимые значения: `true`, `false`. По умолчанию `false` (мягкое удаление) ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID удаляемого сообщения ||" }, "complete": { "type": "boolean", "description": "| Полное удаление из базы данных. Допустимые значения: `true`, `false`. По умолчанию `false` (мягкое удаление) ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.get": { "post": { "summary": "Получить сообщение imbot.v2.Chat.Message.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.get` возвращает сообщение по его ID.", "operationId": "imbot_v2_Chat_Message_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота, целое число больше 0 ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения. Можно взять из `message.id` события ONIMBOTV2MESSAGEADD ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота, целое число больше 0 ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID сообщения. Можно взять из `message.id` события ONIMBOTV2MESSAGEADD ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.getContext": { "post": { "summary": "Получить контекст сообщения imbot.v2.Chat.Message.getContext", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.getContext` возвращает сообщение вместе с соседними, до и после него. Так бот может разобрать историю диалога.", "operationId": "imbot_v2_Chat_Message_getContext", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота, целое число больше 0 ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID центрального сообщения. Можно взять из `message.id` события ONIMBOTV2MESSAGEADD ||" }, "range": { "type": "integer", "description": "| Количество сообщений в каждую сторону от центрального (1–50). По умолчанию `50`. Значение меньше 1 метод заменяет на 1, больше 50 — на 50 ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота, целое число больше 0 ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID центрального сообщения. Можно взять из `message.id` события ONIMBOTV2MESSAGEADD ||" }, "range": { "type": "integer", "description": "| Количество сообщений в каждую сторону от центрального (1–50). По умолчанию `50`. Значение меньше 1 метод заменяет на 1, больше 50 — на 50 ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.read": { "post": { "summary": "Отметить сообщения как прочитанные imbot.v2.Chat.Message.read", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.read` отмечает сообщения как прочитанные от имени бота. Отмечает прочитанными все сообщения до указанного включительно. Если `messageId` не указан — отмечает прочитанными все сообщения в чате.", "operationId": "imbot_v2_Chat_Message_read", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}`. Подробнее — Формат dialogId ||" }, "messageId": { "type": "integer", "description": "| Прочитать все сообщения до этого включительно. Если не указан — прочитает все сообщения в чате ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}`. Подробнее — Формат dialogId ||" }, "messageId": { "type": "integer", "description": "| Прочитать все сообщения до этого включительно. Если не указан — прочитает все сообщения в чате ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.send": { "post": { "summary": "Отправить сообщение imbot.v2.Chat.Message.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.send` отправляет сообщение от имени бота в указанный диалог.", "operationId": "imbot_v2_Chat_Message_send", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Содержимое сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Текст сообщения. Максимальная длина — 20 000 символов. При превышении текст обрезается с добавлением ` (...)` ||" }, "attach": { "type": "object", "description": "\\| `array` | Вложение: объект с массивом `BLOCKS` или сразу массив блоков. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Клавиатура с кнопками. Подробнее: Работа с клавиатурами ||" }, "system": { "type": "boolean", "description": "| Системное сообщение. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Показывать превью ссылок. Допустимые значения: `true`, `false`. По умолчанию `true` ||" }, "replyId": { "type": "integer", "description": "| ID сообщения, на которое отвечает бот ||" }, "templateId": { "type": "string", "description": "| UUID шаблона сообщения ||" }, "forwardIds": { "type": "object", "description": "\\| `array` | Сообщения для пересылки. Поддерживаются два формата:" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Содержимое сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Текст сообщения. Максимальная длина — 20 000 символов. При превышении текст обрезается с добавлением ` (...)` ||" }, "attach": { "type": "object", "description": "\\| `array` | Вложение: объект с массивом `BLOCKS` или сразу массив блоков. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Клавиатура с кнопками. Подробнее: Работа с клавиатурами ||" }, "system": { "type": "boolean", "description": "| Системное сообщение. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Показывать превью ссылок. Допустимые значения: `true`, `false`. По умолчанию `true` ||" }, "replyId": { "type": "integer", "description": "| ID сообщения, на которое отвечает бот ||" }, "templateId": { "type": "string", "description": "| UUID шаблона сообщения ||" }, "forwardIds": { "type": "object", "description": "\\| `array` | Сообщения для пересылки. Поддерживаются два формата:" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.update": { "post": { "summary": "Обновить сообщение imbot.v2.Chat.Message.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.Message.update` обновляет сообщение бота. Бот может обновлять только собственные сообщения.", "operationId": "imbot_v2_Chat_Message_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID обновляемого сообщения ||" }, "fields": { "type": "object", "description": "| Обновляемые поля сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Новый текст сообщения. Максимальная длина — 20 000 символов ||" }, "attach": { "type": "object", "description": "| Новое вложение в полной форме: объект с массивом `BLOCKS`. Краткую форму — массив блоков — метод не принимает и удаляет вложение. Пустая строка удаляет вложение. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Новая клавиатура. Подробнее: Работа с клавиатурами. Для удаления клавиатуры передайте `\"N\"` ||" }, "urlPreview": { "type": "string", "description": "| Показывать превью ссылок. Допустимые значения: `Y`, `N`. По умолчанию `Y` ||" } }, "required": [ "botId", "messageId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "messageId": { "type": "integer", "description": "| ID обновляемого сообщения ||" }, "fields": { "type": "object", "description": "| Обновляемые поля сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Новый текст сообщения. Максимальная длина — 20 000 символов ||" }, "attach": { "type": "object", "description": "| Новое вложение в полной форме: объект с массивом `BLOCKS`. Краткую форму — массив блоков — метод не принимает и удаляет вложение. Пустая строка удаляет вложение. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Новая клавиатура. Подробнее: Работа с клавиатурами. Для удаления клавиатуры передайте `\"N\"` ||" }, "urlPreview": { "type": "string", "description": "| Показывать превью ссылок. Допустимые значения: `Y`, `N`. По умолчанию `Y` ||" } }, "required": [ "botId", "messageId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.TextField.enabled": { "post": { "summary": "Управление полем ввода текста imbot.v2.Chat.TextField.enabled", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.TextField.enabled` включает или отключает поле ввода текста в чате.", "operationId": "imbot_v2_Chat_TextField_enabled", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "enabled": { "type": "boolean", "description": "| Управление полем ввода: `true` — включить, `false` — отключить. По умолчанию `true` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "enabled": { "type": "boolean", "description": "| Управление полем ввода: `true` — включить, `false` — отключить. По умолчанию `true` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.add": { "post": { "summary": "Добавить участников в чат imbot.v2.Chat.User.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.User.add` добавляет участников в чат. Бот должен состоять в чате: по умолчанию добавлять новых пользователей может любой участник. Если в настройках чата это право ограничено, боту нужна соответствующая роль — см. [Роли в чате](./index.md#roles).", "operationId": "imbot_v2_Chat_User_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для добавления ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Массив ID пользователей для добавления ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.delete": { "post": { "summary": "Удалить участника из чата imbot.v2.Chat.User.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.User.delete` удаляет участника из чата. По умолчанию бот должен быть менеджером или владельцем чата — роли описаны в разделе [Роли в чате](./index.md#roles).", "operationId": "imbot_v2_Chat_User_delete", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID пользователя для удаления ||" } }, "required": [ "botId", "dialogId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID пользователя для удаления ||" } }, "required": [ "botId", "dialogId", "userId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.list": { "post": { "summary": "Получить список участников чата imbot.v2.Chat.User.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.User.list` возвращает список участников чата. Если бот состоит в чате, он тоже есть в списке — его отличает поле `bot: true`.", "operationId": "imbot_v2_Chat_User_list", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "order": { "type": "object", "description": "| Сортировка." }, "limit": { "type": "integer", "description": "| Количество записей, от `1` до `200`. По умолчанию `50`. Значение вне диапазона не вызывает ошибку — метод вернет до `50` записей ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "order": { "type": "object", "description": "| Сортировка." }, "limit": { "type": "integer", "description": "| Количество записей, от `1` до `200`. По умолчанию `50`. Значение вне диапазона не вызывает ошибку — метод вернет до `50` записей ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.add": { "post": { "summary": "Создать групповой чат imbot.v2.Chat.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.add` создает групповой чат от имени бота и добавляет бота в участники.", "operationId": "imbot_v2_Chat_add", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "fields": { "type": "object", "description": "| Свойства создаваемого чата (подробное описание) ||" }, "type": { "type": "string", "description": "| Тип чата:" }, "title": { "type": "string", "description": "| Название чата ||" }, "description": { "type": "string", "description": "| Описание чата ||" }, "color": { "type": "string", "description": "| Цвет чата — доступные цвета." }, "avatar": { "type": "string", "description": "| Аватар чата в формате Base64 ||" }, "userIds": { "type": "string", "description": "| Массив ID участников. Бота передавать не нужно — он добавляется в чат автоматически ||" }, "ownerId": { "type": "integer", "description": "| ID владельца чата, по умолчанию — бот. Владелец автоматически добавляется в чат участником и менеджером. Метод не проверяет, существует ли пользователь: с несуществующим ID чат создастся без ошибки и останется без владельца ||" } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "fields": { "type": "object", "description": "| Свойства создаваемого чата (подробное описание) ||" }, "type": { "type": "string", "description": "| Тип чата:" }, "title": { "type": "string", "description": "| Название чата ||" }, "description": { "type": "string", "description": "| Описание чата ||" }, "color": { "type": "string", "description": "| Цвет чата — доступные цвета." }, "avatar": { "type": "string", "description": "| Аватар чата в формате Base64 ||" }, "userIds": { "type": "string", "description": "| Массив ID участников. Бота передавать не нужно — он добавляется в чат автоматически ||" }, "ownerId": { "type": "integer", "description": "| ID владельца чата, по умолчанию — бот. Владелец автоматически добавляется в чат участником и менеджером. Метод не проверяет, существует ли пользователь: с несуществующим ID чат создастся без ошибки и останется без владельца ||" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.get": { "post": { "summary": "Получить информацию о чате imbot.v2.Chat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.get` возвращает информацию о чате, в котором состоит бот. Данные открытого чата или открытого канала метод возвращает, даже если бот в нем не состоит.", "operationId": "imbot_v2_Chat_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID диалога в формате dialogId: `chat{chatId}` для группового чата, `{userId}` для личного ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID диалога в формате dialogId: `chat{chatId}` для группового чата, `{userId}` для личного ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.leave": { "post": { "summary": "Покинуть чат imbot.v2.Chat.leave", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.leave` выводит бота из чата. Бот должен быть участником чата.", "operationId": "imbot_v2_Chat_leave", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.setOwner": { "post": { "summary": "Назначить владельца чата imbot.v2.Chat.setOwner", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.setOwner` передает владение чатом другому пользователю.", "operationId": "imbot_v2_Chat_setOwner", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID нового владельца чата. Пользователь должен состоять в чате — см. предупреждение выше ||" } }, "required": [ "botId", "dialogId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID нового владельца чата. Пользователь должен состоять в чате — см. предупреждение выше ||" } }, "required": [ "botId", "dialogId", "userId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.update": { "post": { "summary": "Обновить свойства чата imbot.v2.Chat.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Chat.update` обновляет свойства группового чата: название, описание, цвет и аватар. Передавайте в `fields` только те свойства, которые нужно изменить. Бот должен быть владельцем чата — это требование не зависит от настроек прав в чате.", "operationId": "imbot_v2_Chat_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "fields": { "type": "object", "description": "| Обновляемые свойства чата (подробное описание). Без `fields` метод ничего не меняет и возвращает `true` ||" }, "title": { "type": "string", "description": "| Новое название чата ||" }, "description": { "type": "string", "description": "| Новое описание чата ||" }, "color": { "type": "string", "description": "| Цвет чата — доступные цвета. Неизвестный код цвета игнорируется без ошибки, цвет не меняется ||" }, "avatar": { "type": "string", "description": "| Новый аватар чата в формате Base64. Если строка не содержит изображение, текущий аватар снимается без ошибки ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен." }, "dialogId": { "type": "string", "description": "| ID группового чата в формате dialogId: `chat{chatId}` ||" }, "fields": { "type": "object", "description": "| Обновляемые свойства чата (подробное описание). Без `fields` метод ничего не меняет и возвращает `true` ||" }, "title": { "type": "string", "description": "| Новое название чата ||" }, "description": { "type": "string", "description": "| Новое описание чата ||" }, "color": { "type": "string", "description": "| Цвет чата — доступные цвета. Неизвестный код цвета игнорируется без ошибки, цвет не меняется ||" }, "avatar": { "type": "string", "description": "| Новый аватар чата в формате Base64. Если строка не содержит изображение, текущий аватар снимается без ошибки ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.answer": { "post": { "summary": "Ответить на команду imbot.v2.Command.answer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Command.answer` отправляет ответ бота на вызов слэш-команды.", "operationId": "imbot_v2_Command_answer", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" }, "messageId": { "type": "integer", "description": "| ID сообщения с командой ||" }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Поля ответного сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Текст ответа. Максимальная длина — 20 000 символов ||" }, "attach": { "type": "object", "description": "\\| `array` | Вложение: объект с массивом `BLOCKS` или сразу массив блоков. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Клавиатура. Подробнее: Работа с клавиатурами ||" }, "system": { "type": "boolean", "description": "| Системное сообщение. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Показывать превью ссылок. Допустимые значения: `true`, `false`. По умолчанию `true` ||" } }, "required": [ "botId", "commandId", "messageId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" }, "messageId": { "type": "integer", "description": "| ID сообщения с командой ||" }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Поля ответного сообщения. Структура объекта описана ниже ||" }, "message": { "type": "string", "description": "| Текст ответа. Максимальная длина — 20 000 символов ||" }, "attach": { "type": "object", "description": "\\| `array` | Вложение: объект с массивом `BLOCKS` или сразу массив блоков. Подробнее: Как использовать вложения ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Клавиатура. Подробнее: Работа с клавиатурами ||" }, "system": { "type": "boolean", "description": "| Системное сообщение. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Показывать превью ссылок. Допустимые значения: `true`, `false`. По умолчанию `true` ||" } }, "required": [ "botId", "commandId", "messageId", "dialogId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.list": { "post": { "summary": "Получить список команд imbot.v2.Command.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Command.list` возвращает список всех команд бота.", "operationId": "imbot_v2_Command_list", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.register": { "post": { "summary": "Зарегистрировать команду imbot.v2.Command.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Command.register` регистрирует слэш-команду бота.", "operationId": "imbot_v2_Command_register", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fields": { "type": "object", "description": "| Объект с параметрами команды (подробное описание) ||" }, "command": { "type": "string", "description": "| Команда без символа `/`. Например: `help` ||" }, "title": { "type": "object", "description": "| Заголовок команды на разных языках. Объект `{langCode: text}`, где `langCode` — двухбуквенный код языка в нижнем регистре: `en`, `ru`, `de` и так далее." }, "params": { "type": "object", "description": "| Описание параметров команды на разных языках. Объект `{langCode: text}`, аналогично `title`. Отображается как подсказка рядом с командой ||" }, "common": { "type": "boolean", "description": "| Общая команда. Допустимые значения: `true`, `false`. По умолчанию `false`. Подробнее — Общие и локальные команды ||" }, "hidden": { "type": "boolean", "description": "| Скрытая команда. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Поддержка экстранет. Допустимые значения: `true`, `false`. По умолчанию `false` ||" } }, "required": [ "botId", "fields", "command" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fields": { "type": "object", "description": "| Объект с параметрами команды (подробное описание) ||" }, "command": { "type": "string", "description": "| Команда без символа `/`. Например: `help` ||" }, "title": { "type": "object", "description": "| Заголовок команды на разных языках. Объект `{langCode: text}`, где `langCode` — двухбуквенный код языка в нижнем регистре: `en`, `ru`, `de` и так далее." }, "params": { "type": "object", "description": "| Описание параметров команды на разных языках. Объект `{langCode: text}`, аналогично `title`. Отображается как подсказка рядом с командой ||" }, "common": { "type": "boolean", "description": "| Общая команда. Допустимые значения: `true`, `false`. По умолчанию `false`. Подробнее — Общие и локальные команды ||" }, "hidden": { "type": "boolean", "description": "| Скрытая команда. Допустимые значения: `true`, `false`. По умолчанию `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Поддержка экстранет. Допустимые значения: `true`, `false`. По умолчанию `false` ||" } }, "required": [ "botId", "fields", "command" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.unregister": { "post": { "summary": "Удалить команду imbot.v2.Command.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Command.unregister` удаляет слэш-команду бота.", "operationId": "imbot_v2_Command_unregister", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" } }, "required": [ "botId", "commandId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" } }, "required": [ "botId", "commandId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.update": { "post": { "summary": "Обновить команду imbot.v2.Command.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Command.update` обновляет слэш-команду бота.", "operationId": "imbot_v2_Command_update", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" }, "fields": { "type": "object", "description": "| Обновляемые поля команды. Структура объекта описана ниже ||" }, "command": { "type": "string", "description": "| Новая команда (без `/`) ||" }, "title": { "type": "object", "description": "| Заголовок команды на разных языках:" }, "params": { "type": "object", "description": "| Описание параметров на разных языках. Аналогично `title`, применяется только к тем языкам, которые переданы в `title` ||" }, "common": { "type": "boolean", "description": "| Общая команда. Допустимые значения: `true`, `false` ||" }, "hidden": { "type": "boolean", "description": "| Скрытая команда. Допустимые значения: `true`, `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Поддержка экстранет. Допустимые значения: `true`, `false` ||" } }, "required": [ "botId", "commandId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "commandId": { "type": "integer", "description": "| ID команды ||" }, "fields": { "type": "object", "description": "| Обновляемые поля команды. Структура объекта описана ниже ||" }, "command": { "type": "string", "description": "| Новая команда (без `/`) ||" }, "title": { "type": "object", "description": "| Заголовок команды на разных языках:" }, "params": { "type": "object", "description": "| Описание параметров на разных языках. Аналогично `title`, применяется только к тем языкам, которые переданы в `title` ||" }, "common": { "type": "boolean", "description": "| Общая команда. Допустимые значения: `true`, `false` ||" }, "hidden": { "type": "boolean", "description": "| Скрытая команда. Допустимые значения: `true`, `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Поддержка экстранет. Допустимые значения: `true`, `false` ||" } }, "required": [ "botId", "commandId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Event.get": { "post": { "summary": "Получить события бота imbot.v2.Event.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Event.get` возвращает события бота, например новые сообщения и вызовы команд. Он нужен ботам с `eventMode: \"fetch\"`, которые сами забирают события запросами.", "operationId": "imbot_v2_Event_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/events/event-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота — тот, что указали при регистрации, или новый после смены токена методом imbot.v2.Bot.update. Обязателен, если метод вызывают через входящий вебхук, для OAuth не нужен ||" }, "offset": { "type": "integer", "description": "| Подтверждает и удаляет из очереди все события с ID меньше указанного значения. Передавайте `nextOffset` из предыдущего ответа. При первом вызове параметр не нужен. По умолчанию `0`." }, "limit": { "type": "integer", "description": "| Максимальное количество возвращаемых событий (1–1000). По умолчанию `100`. Значение вне диапазона метод заменяет ближайшей границей ||" }, "withUserEvents": { "type": "boolean", "description": "| Включить события пользователя (`ONIMV2*`) в ответ вместе с событиями бота (`ONIMBOTV2*`). По умолчанию `false`." } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота — тот, что указали при регистрации, или новый после смены токена методом imbot.v2.Bot.update. Обязателен, если метод вызывают через входящий вебхук, для OAuth не нужен ||" }, "offset": { "type": "integer", "description": "| Подтверждает и удаляет из очереди все события с ID меньше указанного значения. Передавайте `nextOffset` из предыдущего ответа. При первом вызове параметр не нужен. По умолчанию `0`." }, "limit": { "type": "integer", "description": "| Максимальное количество возвращаемых событий (1–1000). По умолчанию `100`. Значение вне диапазона метод заменяет ближайшей границей ||" }, "withUserEvents": { "type": "boolean", "description": "| Включить события пользователя (`ONIMV2*`) в ответ вместе с событиями бота (`ONIMBOTV2*`). По умолчанию `false`." } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.File.download": { "post": { "summary": "Получить ссылку для скачивания файла imbot.v2.File.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.File.download` возвращает ссылку для скачивания файла из чата.", "operationId": "imbot_v2_File_download", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fileId": { "type": "integer", "description": "| ID файла на Диске. Можно получить из ответа метода imbot.v2.File.upload ||" } }, "required": [ "botId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "fileId": { "type": "integer", "description": "| ID файла на Диске. Можно получить из ответа метода imbot.v2.File.upload ||" } }, "required": [ "botId", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.File.upload": { "post": { "summary": "Загрузить файл в чат imbot.v2.File.upload", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.File.upload` загружает файл в чат от имени бота. Объединяет три шага устаревшего API в один вызов: загрузку файла на диск, прикрепление к чату и отправку сообщения.", "operationId": "imbot_v2_File_upload", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Данные файла и сообщения. Структура описана ниже ||" }, "content": { "type": "string", "description": "| Содержимое файла в кодировке Base64. Максимальный размер — 100 МБ ||" }, "message": { "type": "string", "description": "| Текст сообщения, отправляемого вместе с файлом ||" } }, "required": [ "botId", "dialogId", "fields", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID бота ||" }, "botToken": { "type": "string", "description": "| Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth." }, "dialogId": { "type": "string", "description": "| ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}` ||" }, "fields": { "type": "object", "description": "| Данные файла и сообщения. Структура описана ниже ||" }, "content": { "type": "string", "description": "| Содержимое файла в кодировке Base64. Максимальный размер — 100 МБ ||" }, "message": { "type": "string", "description": "| Текст сообщения, отправляемого вместе с файлом ||" } }, "required": [ "botId", "dialogId", "fields", "content" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Revision.get": { "post": { "summary": "Получить ревизии API imbot.v2.Revision.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imbot.v2.Revision.get` возвращает номера ревизий REST API и клиентских протоколов мессенджера. Используется для проверки совместимости: какие методы и возможности поддерживает конкретный Битрикс24.", "operationId": "imbot_v2_Revision_get", "tags": [ "Чат-боты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/chat-bots/chat-bots-v2/imbot.v2/revision-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imconnector.activate": { "post": { "summary": "Активировать коннектор imconnector.activate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.activate` включает или выключает коннектор на указанной открытой линии.", "operationId": "imconnector_activate", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-activate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "ACTIVE": { "type": "string", "description": "| Признак включения. Битрикс24 различает только пустые и непустые значения:" } }, "required": [ "CONNECTOR", "LINE", "ACTIVE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "ACTIVE": { "type": "string", "description": "| Признак включения. Битрикс24 различает только пустые и непустые значения:" } }, "required": [ "CONNECTOR", "LINE", "ACTIVE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.chat.name.set": { "post": { "summary": "Установить новое имя чата imconnector.chat.name.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.chat.name.set` переименовывает в Битрикс24 чат открытой линии, который соответствует диалогу внешней системы с указанным `CHAT_ID`. Во внешней системе название диалога остается прежним.", "operationId": "imconnector_chat_name_set", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-chat-name-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "CHAT_ID": { "type": "string", "description": "| Идентификатор чата во внешней системе — то же значение, что передают в `chat.id` метода imconnector.send.messages ||" }, "USER_ID": { "type": "string", "description": "| Идентификатор собеседника во внешней системе — то же значение, что передают в `user.id` метода imconnector.send.messages. Идентификатор пользователя Битрикс24 здесь не подходит." } }, "required": [ "CONNECTOR", "LINE", "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "CHAT_ID": { "type": "string", "description": "| Идентификатор чата во внешней системе — то же значение, что передают в `chat.id` метода imconnector.send.messages ||" }, "USER_ID": { "type": "string", "description": "| Идентификатор собеседника во внешней системе — то же значение, что передают в `user.id` метода imconnector.send.messages. Идентификатор пользователя Битрикс24 здесь не подходит." } }, "required": [ "CONNECTOR", "LINE", "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.connector.data.set": { "post": { "summary": "Установить настройки коннектора imconnector.connector.data.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.connector.data.set` сохраняет в Битрикс24 настройки пользовательского коннектора на указанной открытой линии: идентификатор внешнего канала, ссылки на него и название.", "operationId": "imconnector_connector_data_set", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-connector-data-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "DATA": { "type": "object", "description": "| Объект настроек канала во внешней системе." }, "ID": { "type": "string", "description": "| Идентификатор канала во внешней системе, например, `channel-123`." }, "URL": { "type": "string", "description": "| Полная ссылка на чат или канал во внешней системе ||" }, "URL_IM": { "type": "string", "description": "| Ссылка на чат, которую оператор открывает из интерфейса открытых линий. Если отдельной ссылки для оператора нет, поле можно не передавать — у коннектора останется только `URL` ||" } }, "required": [ "CONNECTOR", "LINE", "DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "DATA": { "type": "object", "description": "| Объект настроек канала во внешней системе." }, "ID": { "type": "string", "description": "| Идентификатор канала во внешней системе, например, `channel-123`." }, "URL": { "type": "string", "description": "| Полная ссылка на чат или канал во внешней системе ||" }, "URL_IM": { "type": "string", "description": "| Ссылка на чат, которую оператор открывает из интерфейса открытых линий. Если отдельной ссылки для оператора нет, поле можно не передавать — у коннектора останется только `URL` ||" } }, "required": [ "CONNECTOR", "LINE", "DATA" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.delete.messages": { "post": { "summary": "Удалить отправленные сообщения imconnector.delete.messages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.delete.messages` удаляет сообщения из открытой линии, которые были переданы внешней системой.", "operationId": "imconnector_delete_messages", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-delete-messages.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений для удаления. Каждый элемент массива — объект сообщения с тремя обязательными блоками: `user`, `message`, `chat`. Структура объекта подробно описана ниже ||" }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата или канала внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе." } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений для удаления. Каждый элемент массива — объект сообщения с тремя обязательными блоками: `user`, `message`, `chat`. Структура объекта подробно описана ниже ||" }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата или канала внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе." } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.list": { "post": { "summary": "Получить список коннекторов imconnector.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.list` возвращает список коннекторов, которые доступны в Битрикс24 и могут быть подключены к открытой линии.", "operationId": "imconnector_list", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.register": { "post": { "summary": "Зарегистрировать коннектор imconnector.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.register` регистрирует пользовательский коннектор для открытых линий.", "operationId": "imconnector_register", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Уникальный идентификатор коннектора. Метод приводит значение к нижнему регистру. Рекомендуется добавлять в начало идентификатора уникальный префикс, чтобы избежать пересечения с текущими и будущими идентификаторами других коннекторов. Для формирования идентификатора используйте цифры, буквы в н..." }, "ICON": { "type": "object", "description": "| Параметры основной иконки." }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встраивания для настроек коннектора. По этому адресу Битрикс24 открывает интерфейс настройки в слайдере для пользователя. Подробнее о встраивании интерфейсов читайте в статье Механизм встраивания виджетов ||" }, "ICON_DISABLED": { "type": "object", "description": "| Параметры иконки неактивного состояния." }, "DEL_EXTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает удалять входящие сообщения. Значение по умолчанию `true` ||" }, "EDIT_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает редактировать сообщения операторов. Значение по умолчанию `true` ||" }, "DEL_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает удалять сообщения операторов. Значение по умолчанию `true` ||" }, "NEWSLETTER": { "type": "boolean", "description": "| Разрешает использовать канал в CRM-рассылках. Значение по умолчанию `true` ||" }, "NEED_SYSTEM_MESSAGES": { "type": "boolean", "description": "| Разрешает отправку системных сообщений в канал. Значение по умолчанию `true` ||" }, "NEED_SIGNATURE": { "type": "boolean", "description": "| Добавляет подпись оператора в сообщения. Значение по умолчанию `true` ||" }, "CHAT_GROUP": { "type": "boolean", "description": "| Признак режима обработки чатов коннектора: `true` — группировка по `chat.id` (групповой чат), `false` — по `user.id` (чат один на один). Значение по умолчанию `false`." }, "DATA_IMAGE": { "type": "string", "description": "| SVG-иконка в формате Data URI: строка с префиксом `data:image/svg+xml,`, после которого передается содержимое SVG, обычно URL-кодированное ||" }, "COLOR": { "type": "string", "description": "| Цвет фона иконки. Пример: `#69acc0` ||" }, "SIZE": { "type": "string", "description": "| Размер фона. Пример: `90%` ||" }, "POSITION": { "type": "string", "description": "| Позиция фона. Пример: `center` ||" } }, "required": [ "ID", "ICON", "PLACEMENT_HANDLER", "DATA_IMAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Уникальный идентификатор коннектора. Метод приводит значение к нижнему регистру. Рекомендуется добавлять в начало идентификатора уникальный префикс, чтобы избежать пересечения с текущими и будущими идентификаторами других коннекторов. Для формирования идентификатора используйте цифры, буквы в н..." }, "ICON": { "type": "object", "description": "| Параметры основной иконки." }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL обработчика встраивания для настроек коннектора. По этому адресу Битрикс24 открывает интерфейс настройки в слайдере для пользователя. Подробнее о встраивании интерфейсов читайте в статье Механизм встраивания виджетов ||" }, "ICON_DISABLED": { "type": "object", "description": "| Параметры иконки неактивного состояния." }, "DEL_EXTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает удалять входящие сообщения. Значение по умолчанию `true` ||" }, "EDIT_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает редактировать сообщения операторов. Значение по умолчанию `true` ||" }, "DEL_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Разрешает удалять сообщения операторов. Значение по умолчанию `true` ||" }, "NEWSLETTER": { "type": "boolean", "description": "| Разрешает использовать канал в CRM-рассылках. Значение по умолчанию `true` ||" }, "NEED_SYSTEM_MESSAGES": { "type": "boolean", "description": "| Разрешает отправку системных сообщений в канал. Значение по умолчанию `true` ||" }, "NEED_SIGNATURE": { "type": "boolean", "description": "| Добавляет подпись оператора в сообщения. Значение по умолчанию `true` ||" }, "CHAT_GROUP": { "type": "boolean", "description": "| Признак режима обработки чатов коннектора: `true` — группировка по `chat.id` (групповой чат), `false` — по `user.id` (чат один на один). Значение по умолчанию `false`." }, "DATA_IMAGE": { "type": "string", "description": "| SVG-иконка в формате Data URI: строка с префиксом `data:image/svg+xml,`, после которого передается содержимое SVG, обычно URL-кодированное ||" }, "COLOR": { "type": "string", "description": "| Цвет фона иконки. Пример: `#69acc0` ||" }, "SIZE": { "type": "string", "description": "| Размер фона. Пример: `90%` ||" }, "POSITION": { "type": "string", "description": "| Позиция фона. Пример: `center` ||" } }, "required": [ "ID", "ICON", "PLACEMENT_HANDLER", "DATA_IMAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.messages": { "post": { "summary": "Отправить сообщения в Битрикс24 imconnector.send.messages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.send.messages` принимает сообщения из внешней системы и передает их в открытую линию Битрикс24 через пользовательский коннектор.", "operationId": "imconnector_send_messages", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-send-messages.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений. Каждый элемент массива — одно сообщение в формате объекта с тремя обязательными блоками: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе. Значение формируется на стороне внешней системы ||" }, "last_name": { "type": "string", "description": "| Фамилия пользователя ||" }, "picture": { "type": "object", "description": "| Аватар пользователя. Передавайте как объект с полем `url`, например, `{\"url\":\"https://example.ru/u42.png\"}`. Ссылка должна быть публичной ||" }, "url": { "type": "string", "description": "| Ссылка на профиль пользователя во внешней системе ||" }, "gender": { "type": "string", "description": "| Пол пользователя. Поддерживаются значения `male` и `female` ||" }, "email": { "type": "string", "description": "| Email пользователя ||" }, "phone": { "type": "string", "description": "| Телефон пользователя ||" }, "skip_phone_validate": { "type": "string", "description": "| Отключает проверку телефона перед сохранением в CRM. Допустимое значение — `Y`. Если проверка должна выполняться, не передавайте параметр ||" }, "date": { "type": "integer", "description": "| Время сообщения в Unix Timestamp в секундах ||" }, "text": { "type": "string", "description": "| Текст сообщения. Обязательно передайте элемент `text` или `files`." }, "files": { "type": "array", "items": {}, "description": "| Массив файлов. Каждый файл передается как массив вида `array('url' => 'Ссылка на файл', 'name' => 'Имя файла')`. Ссылка `url` должна быть доступна из Битрикс24." }, "disable_crm": { "type": "string", "description": "| Отключает CRM трекер для сообщения. Допустимое значение — `Y`. Если CRM трекер должен работать, не передавайте параметр ||" }, "user_id": { "type": "integer", "description": "| Идентификатор менеджера в Битрикс24. Если передать `user_id`, сообщение отправится от имени этого менеджера ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений. Каждый элемент массива — одно сообщение в формате объекта с тремя обязательными блоками: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе. Значение формируется на стороне внешней системы ||" }, "last_name": { "type": "string", "description": "| Фамилия пользователя ||" }, "picture": { "type": "object", "description": "| Аватар пользователя. Передавайте как объект с полем `url`, например, `{\"url\":\"https://example.ru/u42.png\"}`. Ссылка должна быть публичной ||" }, "url": { "type": "string", "description": "| Ссылка на профиль пользователя во внешней системе ||" }, "gender": { "type": "string", "description": "| Пол пользователя. Поддерживаются значения `male` и `female` ||" }, "email": { "type": "string", "description": "| Email пользователя ||" }, "phone": { "type": "string", "description": "| Телефон пользователя ||" }, "skip_phone_validate": { "type": "string", "description": "| Отключает проверку телефона перед сохранением в CRM. Допустимое значение — `Y`. Если проверка должна выполняться, не передавайте параметр ||" }, "date": { "type": "integer", "description": "| Время сообщения в Unix Timestamp в секундах ||" }, "text": { "type": "string", "description": "| Текст сообщения. Обязательно передайте элемент `text` или `files`." }, "files": { "type": "array", "items": {}, "description": "| Массив файлов. Каждый файл передается как массив вида `array('url' => 'Ссылка на файл', 'name' => 'Имя файла')`. Ссылка `url` должна быть доступна из Битрикс24." }, "disable_crm": { "type": "string", "description": "| Отключает CRM трекер для сообщения. Допустимое значение — `Y`. Если CRM трекер должен работать, не передавайте параметр ||" }, "user_id": { "type": "integer", "description": "| Идентификатор менеджера в Битрикс24. Если передать `user_id`, сообщение отправится от имени этого менеджера ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.status.delivery": { "post": { "summary": "Обновить статус «доставлено» imconnector.send.status.delivery", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.send.status.delivery` подтверждает в Битрикс24, что исходящее сообщение открытой линии доставлено во внешнюю систему.", "operationId": "imconnector_send_status_delivery", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-send-status-delivery.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив статусов доставки. Каждый элемент массива — объект с блоками `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Внутренние идентификаторы сообщения в Битрикс24 (подробное описание) ||" }, "message": { "type": "object", "description": "| Данные сообщения во внешней системе (подробное описание) ||" }, "chat": { "type": "object", "description": "| Данные чата во внешней системе (подробное описание) ||" }, "message_id": { "type": "integer", "description": "| Идентификатор сообщения в Битрикс24, для которого нужно установить статус доставки. Единственное значение, по которому Битрикс24 находит сообщение ||" }, "chat_id": { "type": "integer", "description": "| Идентификатор чата открытой линии в Битрикс24 для исходящего сообщения. На обработку статуса не влияет ||" }, "id": { "type": "array", "items": {}, "description": "| Массив внешних идентификаторов сообщений, для которых передается статус доставки. Даже для одного сообщения передавайте массив, например, `[\"ext-msg-1007\"]`." }, "date": { "type": "integer", "description": "| Время доставки сообщения в Unix Timestamp в секундах. На обработку статуса не влияет ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "im", "message_id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив статусов доставки. Каждый элемент массива — объект с блоками `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Внутренние идентификаторы сообщения в Битрикс24 (подробное описание) ||" }, "message": { "type": "object", "description": "| Данные сообщения во внешней системе (подробное описание) ||" }, "chat": { "type": "object", "description": "| Данные чата во внешней системе (подробное описание) ||" }, "message_id": { "type": "integer", "description": "| Идентификатор сообщения в Битрикс24, для которого нужно установить статус доставки. Единственное значение, по которому Битрикс24 находит сообщение ||" }, "chat_id": { "type": "integer", "description": "| Идентификатор чата открытой линии в Битрикс24 для исходящего сообщения. На обработку статуса не влияет ||" }, "id": { "type": "array", "items": {}, "description": "| Массив внешних идентификаторов сообщений, для которых передается статус доставки. Даже для одного сообщения передавайте массив, например, `[\"ext-msg-1007\"]`." }, "date": { "type": "integer", "description": "| Время доставки сообщения в Unix Timestamp в секундах. На обработку статуса не влияет ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "im", "message_id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.status.reading": { "post": { "summary": "Передать статус «прочитано» imconnector.send.status.reading", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации - метод скрыт, потому что по факту бесполезен, обработчик onReceivedStatusReading — это заглушка, в нем просто return true;", "operationId": "imconnector_send_status_reading", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-send-status-reading.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив статусов прочтения. Каждый элемент массива — объект с блоками `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Внутренние идентификаторы сообщения в Битрикс24 (подробное описание) ||" }, "message": { "type": "object", "description": "| Данные сообщения во внешней системе (подробное описание) ||" }, "chat": { "type": "object", "description": "| Данные чата во внешней системе (подробное описание) ||" }, "message_id": { "type": "integer", "description": "| Идентификатор сообщения в Битрикс24 ||" }, "chat_id": { "type": "integer", "description": "| Идентификатор чата открытой линии в Битрикс24 ||" }, "id": { "type": "array", "items": {}, "description": "| Массив внешних идентификаторов сообщений. Даже для одного сообщения передавайте массив, например, `[\"ext-msg-1007\"]` ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив статусов прочтения. Каждый элемент массива — объект с блоками `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Внутренние идентификаторы сообщения в Битрикс24 (подробное описание) ||" }, "message": { "type": "object", "description": "| Данные сообщения во внешней системе (подробное описание) ||" }, "chat": { "type": "object", "description": "| Данные чата во внешней системе (подробное описание) ||" }, "message_id": { "type": "integer", "description": "| Идентификатор сообщения в Битрикс24 ||" }, "chat_id": { "type": "integer", "description": "| Идентификатор чата открытой линии в Битрикс24 ||" }, "id": { "type": "array", "items": {}, "description": "| Массив внешних идентификаторов сообщений. Даже для одного сообщения передавайте массив, например, `[\"ext-msg-1007\"]` ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.status": { "post": { "summary": "Получить статус коннектора imconnector.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.status` возвращает текущий статус коннектора для указанной открытой линии.", "operationId": "imconnector_status", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." } }, "required": [ "CONNECTOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." } }, "required": [ "CONNECTOR" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.unregister": { "post": { "summary": "Отменить регистрацию коннектора imconnector.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.unregister` удаляет пользовательский коннектор.", "operationId": "imconnector_unregister", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор коннектора, который был передан при регистрации в imconnector.register ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор коннектора, который был передан при регистрации в imconnector.register ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.update.messages": { "post": { "summary": "Изменить отправленные сообщения imconnector.update.messages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imconnector.update.messages` обновляет данные ранее переданных сообщений внешней системы в открытой линии.", "operationId": "imconnector_update_messages", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/imconnector/imconnector-update-messages.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений для обновления. Каждый элемент массива — одно сообщение в формате объекта с тремя обязательными блоками: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе ||" }, "last_name": { "type": "string", "description": "| Фамилия пользователя ||" }, "picture": { "type": "object", "description": "| Аватар пользователя в формате объекта с полем `url`, например `{\"url\":\"https://example.ru/u42.png\"}` ||" }, "url": { "type": "string", "description": "| Ссылка на профиль пользователя во внешней системе ||" }, "gender": { "type": "string", "description": "| Пол пользователя. Поддерживаются значения `male` и `female` ||" }, "email": { "type": "string", "description": "| Email пользователя ||" }, "phone": { "type": "string", "description": "| Телефон пользователя ||" }, "skip_phone_validate": { "type": "string", "description": "| Отключает проверку телефона перед сохранением в CRM. Допустимое значение — `Y`. Если проверка должна выполняться, не передавайте параметр ||" }, "date": { "type": "integer", "description": "| Время сообщения в Unix Timestamp в секундах ||" }, "text": { "type": "string", "description": "| Новый текст сообщения. Передавайте `text` или `files`" }, "files": { "type": "array", "items": {}, "description": "| Массив файлов. Каждый файл передается как массив вида `array('url' => 'Ссылка на файл', 'name' => 'Имя файла')` ||" }, "disable_crm": { "type": "string", "description": "| Отключает CRM трекер для сообщения. Допустимое значение — `Y` ||" }, "user_id": { "type": "integer", "description": "| Идентификатор менеджера в Битрикс24. Если передать `user_id`, сообщение обновится от имени этого менеджера ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Идентификатор открытой линии." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив сообщений для обновления. Каждый элемент массива — одно сообщение в формате объекта с тремя обязательными блоками: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Данные пользователя внешней системы." }, "message": { "type": "object", "description": "| Данные сообщения внешней системы." }, "chat": { "type": "object", "description": "| Данные чата внешней системы." }, "id": { "type": "string", "description": "| Идентификатор пользователя во внешней системе ||" }, "last_name": { "type": "string", "description": "| Фамилия пользователя ||" }, "picture": { "type": "object", "description": "| Аватар пользователя в формате объекта с полем `url`, например `{\"url\":\"https://example.ru/u42.png\"}` ||" }, "url": { "type": "string", "description": "| Ссылка на профиль пользователя во внешней системе ||" }, "gender": { "type": "string", "description": "| Пол пользователя. Поддерживаются значения `male` и `female` ||" }, "email": { "type": "string", "description": "| Email пользователя ||" }, "phone": { "type": "string", "description": "| Телефон пользователя ||" }, "skip_phone_validate": { "type": "string", "description": "| Отключает проверку телефона перед сохранением в CRM. Допустимое значение — `Y`. Если проверка должна выполняться, не передавайте параметр ||" }, "date": { "type": "integer", "description": "| Время сообщения в Unix Timestamp в секундах ||" }, "text": { "type": "string", "description": "| Новый текст сообщения. Передавайте `text` или `files`" }, "files": { "type": "array", "items": {}, "description": "| Массив файлов. Каждый файл передается как массив вида `array('url' => 'Ссылка на файл', 'name' => 'Имя файла')` ||" }, "disable_crm": { "type": "string", "description": "| Отключает CRM трекер для сообщения. Допустимое значение — `Y` ||" }, "user_id": { "type": "integer", "description": "| Идентификатор менеджера в Битрикс24. Если передать `user_id`, сообщение обновится от имени этого менеджера ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.finish": { "post": { "summary": "Завершить диалог imopenlines.bot.session.finish", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.bot.session.finish` завершает текущий диалог открытой линии от имени чат-бота приложения.", "operationId": "imopenlines_bot_session_finish", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, диалог которого нужно завершить." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, диалог которого нужно завершить." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.message.send": { "post": { "summary": "Отправить автоматическое сообщение в диалог imopenlines.bot.session.message.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.bot.session.message.send` отправляет в диалог открытой линии автоматическое сообщение от чат-бота приложения.", "operationId": "imopenlines_bot_session_message_send", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-message-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, в который метод отправляет сообщение." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения для режима `NAME=DEFAULT`. По умолчанию используется пустая строка." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, в который метод отправляет сообщение." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения для режима `NAME=DEFAULT`. По умолчанию используется пустая строка." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.operator": { "post": { "summary": "Переключить диалог на свободного оператора imopenlines.bot.session.operator", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.bot.session.operator` переключает диалог со стороны чат-бота на свободного оператора открытой линии.", "operationId": "imopenlines_bot_session_operator", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-operator.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, который нужно передать свободному оператору." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, который нужно передать свободному оператору." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.transfer": { "post": { "summary": "Перевести диалог на оператора или очередь imopenlines.bot.session.transfer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.bot.session.transfer` переводит диалог открытой линии от чат-бота на указанного оператора или очередь.", "operationId": "imopenlines_bot_session_transfer", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-transfer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, диалог которого нужно перевести." }, "USER_ID": { "type": "integer", "description": "| Идентификатор сотрудника, на которого нужно перевести диалог." }, "QUEUE_ID": { "type": "integer", "description": "| Идентификатор очереди, в которую нужно перевести диалог." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Универсальный параметр назначения перевода." }, "LEAVE": { "type": "boolean", "description": "| Флаг присутствия чат-бота в диалоге после перевода." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата, диалог которого нужно перевести." }, "USER_ID": { "type": "integer", "description": "| Идентификатор сотрудника, на которого нужно перевести диалог." }, "QUEUE_ID": { "type": "integer", "description": "| Идентификатор очереди, в которую нужно перевести диалог." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Универсальный параметр назначения перевода." }, "LEAVE": { "type": "boolean", "description": "| Флаг присутствия чат-бота в диалоге после перевода." }, "CLIENT_ID": { "type": "string", "description": "| Параметр обязателен только для вебхуков." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.add": { "post": { "summary": "Добавить открытую линию imopenlines.config.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.add` добавляет новую открытую линию.", "operationId": "imopenlines_config_add", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Объект с настройками открытой линии (подробное описание). Если не передан, линия создается с настройками по умолчанию ||" }, "LINE_NAME": { "type": "string", "description": "| Название открытой линии, не более 255 символов. Если не передано, название формируется автоматически ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность линии. Возможные значения:" }, "QUEUE": { "type": "array", "items": {}, "description": "| Очередь операторов. Передается массив объектов с полями `ENTITY_TYPE` и `ENTITY_ID`." }, "QUEUE_TYPE": { "type": "string", "description": "| Режим распределения обращений. Возможные значения:" }, "QUEUE_TIME": { "type": "integer", "description": "| Время в секундах до перехода обращения к следующему оператору ||" }, "NO_ANSWER_TIME": { "type": "integer", "description": "| Время в секундах до срабатывания сценария без ответа ||" }, "WELCOME_MESSAGE": { "type": "string", "maxLength": 1, "description": "| Отправлять приветственное сообщение. Возможные значения:" }, "WELCOME_MESSAGE_TEXT": { "type": "string", "description": "| Текст приветственного сообщения ||" }, "WORKTIME_ENABLE": { "type": "string", "maxLength": 1, "description": "| Учитывать рабочее время линии. Возможные значения:" }, "WORKTIME_FROM": { "type": "string", "description": "| Начало рабочего времени в формате `HH:MM` ||" }, "WORKTIME_TO": { "type": "string", "description": "| Окончание рабочего времени в формате `HH:MM` ||" }, "WORKTIME_TIMEZONE": { "type": "string", "description": "| Часовой пояс, например `Europe/Kaliningrad` ||" }, "CRM": { "type": "string", "maxLength": 1, "description": "| Искать клиента в CRM. Возможные значения:" }, "CRM_CREATE": { "type": "string", "description": "| Что создавать в CRM для нового клиента ||" }, "VOTE_MESSAGE": { "type": "string", "maxLength": 1, "description": "| Запрашивать оценку качества обслуживания. Возможные значения:" }, "LANGUAGE_ID": { "type": "string", "description": "| Язык линии, например `ru` ||" }, "CRM_CREATE_SECOND": { "type": "string", "description": "| Дополнительный режим создания элемента CRM ||" }, "CRM_CREATE_THIRD": { "type": "string", "maxLength": 1, "description": "| Создавать третий элемент CRM. Возможные значения:" }, "CRM_CHAT_TRACKER": { "type": "string", "maxLength": 1, "description": "| Включить чат-трекер для CRM. Возможные значения:" }, "CRM_FORWARD": { "type": "string", "maxLength": 1, "description": "| Переводить обращение на ответственного по CRM. Возможные значения:" }, "CRM_TRANSFER_CHANGE": { "type": "string", "maxLength": 1, "description": "| Менять ответственного в CRM при переводе диалога. Возможные значения:" }, "CRM_SOURCE": { "type": "string", "description": "| Источник для создаваемого элемента CRM ||" }, "MAX_CHAT": { "type": "integer", "description": "| Максимальное число одновременных диалогов у оператора ||" }, "TYPE_MAX_CHAT": { "type": "string", "description": "| Тип ограничения `MAX_CHAT`. Возможные значения:" }, "CATEGORY_ENABLE": { "type": "string", "maxLength": 1, "description": "| Включить категории. Возможные значения:" }, "CATEGORY_ID": { "type": "integer", "description": "| Идентификатор категории ||" }, "SESSION_PRIORITY": { "type": "integer", "description": "| Приоритет сессии в очереди ||" }, "WELCOME_BOT_ENABLE": { "type": "string", "maxLength": 1, "description": "| Включить чат-бота приветствия. Возможные значения:" }, "WELCOME_BOT_JOIN": { "type": "string", "description": "| Когда подключать бота. Возможные значения:" }, "WELCOME_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота ||" }, "WELCOME_BOT_TIME": { "type": "integer", "description": "| Через сколько секунд переводить диалог от бота в очередь ||" }, "WELCOME_BOT_LEFT": { "type": "string", "description": "| Когда отключать бота. Возможные значения:" }, "CHECK_AVAILABLE": { "type": "string", "maxLength": 1, "description": "| Проверять доступность оператора при распределении. Возможные значения:" }, "WATCH_TYPING": { "type": "string", "maxLength": 1, "description": "| Показывать индикатор набора текста. Возможные значения:" }, "SEND_WELCOME_EACH_SESSION": { "type": "string", "maxLength": 1, "description": "| Отправлять приветствие в каждой сессии. Возможные значения:" }, "OPERATOR_DATA": { "type": "string", "description": "| Формат данных об операторе. Возможные значения:" }, "DEFAULT_OPERATOR_DATA": { "type": "object", "description": "| Данные оператора по умолчанию. Возможные поля:" }, "NO_ANSWER_RULE": { "type": "string", "description": "| Сценарий, если оператор не ответил. Возможные значения:" }, "NO_ANSWER_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для сценария без ответа ||" }, "NO_ANSWER_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для сценария без ответа ||" }, "NO_ANSWER_TEXT": { "type": "string", "description": "| Текст для сценария без ответа ||" }, "WORKTIME_DAYOFF": { "type": "array", "items": {}, "description": "| Выходные дни. Возможные значения элементов:" }, "WORKTIME_HOLIDAYS": { "type": "string", "description": "| Праздничные дни в формате строки, перечисленные через запятую `DD.MM,DD.MM` ||" }, "WORKTIME_DAYOFF_RULE": { "type": "string", "description": "| Сценарий в нерабочее время. Возможные значения:" }, "WORKTIME_DAYOFF_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для нерабочего времени ||" }, "WORKTIME_DAYOFF_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для нерабочего времени ||" }, "WORKTIME_DAYOFF_TEXT": { "type": "string", "description": "| Текст сообщения в нерабочее время ||" }, "CLOSE_RULE": { "type": "string", "description": "| Сценарий при закрытии. Возможные значения:" }, "CLOSE_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы при закрытии ||" }, "CLOSE_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота при закрытии ||" }, "CLOSE_TEXT": { "type": "string", "description": "| Текст сообщения при закрытии ||" }, "VOTE_TIME_LIMIT": { "type": "integer", "description": "| Лимит времени на голосование ||" }, "VOTE_CLOSING_DELAY": { "type": "string", "maxLength": 1, "description": "| Закрывать сессию сразу после оценки. Возможные значения:" }, "VOTE_BEFORE_FINISH": { "type": "string", "maxLength": 1, "description": "| Запрашивать оценку до завершения. Возможные значения:" }, "VOTE_MESSAGE_1_TEXT": { "type": "string", "description": "| Текст запроса оценки в виджете ||" }, "VOTE_MESSAGE_1_LIKE": { "type": "string", "description": "| Текст после положительной оценки в виджете ||" }, "VOTE_MESSAGE_1_DISLIKE": { "type": "string", "description": "| Текст после отрицательной оценки в виджете ||" }, "VOTE_MESSAGE_2_TEXT": { "type": "string", "description": "| Текст запроса оценки в внешних каналах ||" }, "VOTE_MESSAGE_2_LIKE": { "type": "string", "description": "| Текст после положительной оценки в внешних каналах ||" }, "VOTE_MESSAGE_2_DISLIKE": { "type": "string", "description": "| Текст после отрицательной оценки в внешних каналах ||" }, "AUTO_CLOSE_RULE": { "type": "string", "description": "| Сценарий автозакрытия. Возможные значения:" }, "FULL_CLOSE_TIME": { "type": "integer", "description": "| Время полного закрытия после ручного закрытия ||" }, "AUTO_CLOSE_TIME": { "type": "integer", "description": "| Время до автозакрытия ||" }, "AUTO_CLOSE_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для автозакрытия ||" }, "AUTO_CLOSE_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для автозакрытия ||" }, "AUTO_CLOSE_TEXT": { "type": "string", "description": "| Текст при автозакрытии ||" }, "AUTO_EXPIRE_TIME": { "type": "integer", "description": "| Срок жизни автоматически закрытой сессии ||" }, "TEMPORARY": { "type": "string", "maxLength": 1, "description": "| Создать временную линию. Возможные значения:" }, "QUICK_ANSWERS_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока быстрых ответов ||" }, "KPI_FIRST_ANSWER_TIME": { "type": "integer", "description": "| Контроль времени первого ответа ||" }, "KPI_FIRST_ANSWER_ALERT": { "type": "string", "maxLength": 1, "description": "| Включить уведомление о первом ответе. Возможные значения:" }, "KPI_FIRST_ANSWER_LIST": { "type": "array", "items": {}, "description": "| Список получателей уведомления о первом ответе ||" }, "KPI_FIRST_ANSWER_TEXT": { "type": "string", "description": "| Текст уведомления о первом ответе ||" }, "KPI_FURTHER_ANSWER_TIME": { "type": "integer", "description": "| Контроль времени последующих ответов ||" }, "KPI_FURTHER_ANSWER_ALERT": { "type": "string", "maxLength": 1, "description": "| Включить уведомление о последующих ответах. Возможные значения:" }, "KPI_FURTHER_ANSWER_LIST": { "type": "array", "items": {}, "description": "| Список получателей уведомления о последующих ответах ||" }, "KPI_FURTHER_ANSWER_TEXT": { "type": "string", "description": "| Текст уведомления о последующих ответах ||" }, "KPI_CHECK_OPERATOR_ACTIVITY": { "type": "string", "maxLength": 1, "description": "| Контролировать активность оператора. Возможные значения:" }, "USE_WELCOME_FORM": { "type": "string", "maxLength": 1, "description": "| Использовать приветственную CRM-форму. Возможные значения:" }, "WELCOME_FORM_ID": { "type": "integer", "description": "| Идентификатор приветственной CRM-формы ||" }, "WELCOME_FORM_DELAY": { "type": "string", "maxLength": 1, "description": "| Показывать форму с задержкой. Возможные значения:" }, "CONFIRM_CLOSE": { "type": "string", "maxLength": 1, "description": "| Запрашивать подтверждение закрытия. Возможные значения:" }, "IGNORE_WELCOME_FORM_RESPONSIBLE": { "type": "string", "maxLength": 1, "description": "| Игнорировать ответственного в приветственной форме. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Объект с настройками открытой линии (подробное описание). Если не передан, линия создается с настройками по умолчанию ||" }, "LINE_NAME": { "type": "string", "description": "| Название открытой линии, не более 255 символов. Если не передано, название формируется автоматически ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность линии. Возможные значения:" }, "QUEUE": { "type": "array", "items": {}, "description": "| Очередь операторов. Передается массив объектов с полями `ENTITY_TYPE` и `ENTITY_ID`." }, "QUEUE_TYPE": { "type": "string", "description": "| Режим распределения обращений. Возможные значения:" }, "QUEUE_TIME": { "type": "integer", "description": "| Время в секундах до перехода обращения к следующему оператору ||" }, "NO_ANSWER_TIME": { "type": "integer", "description": "| Время в секундах до срабатывания сценария без ответа ||" }, "WELCOME_MESSAGE": { "type": "string", "maxLength": 1, "description": "| Отправлять приветственное сообщение. Возможные значения:" }, "WELCOME_MESSAGE_TEXT": { "type": "string", "description": "| Текст приветственного сообщения ||" }, "WORKTIME_ENABLE": { "type": "string", "maxLength": 1, "description": "| Учитывать рабочее время линии. Возможные значения:" }, "WORKTIME_FROM": { "type": "string", "description": "| Начало рабочего времени в формате `HH:MM` ||" }, "WORKTIME_TO": { "type": "string", "description": "| Окончание рабочего времени в формате `HH:MM` ||" }, "WORKTIME_TIMEZONE": { "type": "string", "description": "| Часовой пояс, например `Europe/Kaliningrad` ||" }, "CRM": { "type": "string", "maxLength": 1, "description": "| Искать клиента в CRM. Возможные значения:" }, "CRM_CREATE": { "type": "string", "description": "| Что создавать в CRM для нового клиента ||" }, "VOTE_MESSAGE": { "type": "string", "maxLength": 1, "description": "| Запрашивать оценку качества обслуживания. Возможные значения:" }, "LANGUAGE_ID": { "type": "string", "description": "| Язык линии, например `ru` ||" }, "CRM_CREATE_SECOND": { "type": "string", "description": "| Дополнительный режим создания элемента CRM ||" }, "CRM_CREATE_THIRD": { "type": "string", "maxLength": 1, "description": "| Создавать третий элемент CRM. Возможные значения:" }, "CRM_CHAT_TRACKER": { "type": "string", "maxLength": 1, "description": "| Включить чат-трекер для CRM. Возможные значения:" }, "CRM_FORWARD": { "type": "string", "maxLength": 1, "description": "| Переводить обращение на ответственного по CRM. Возможные значения:" }, "CRM_TRANSFER_CHANGE": { "type": "string", "maxLength": 1, "description": "| Менять ответственного в CRM при переводе диалога. Возможные значения:" }, "CRM_SOURCE": { "type": "string", "description": "| Источник для создаваемого элемента CRM ||" }, "MAX_CHAT": { "type": "integer", "description": "| Максимальное число одновременных диалогов у оператора ||" }, "TYPE_MAX_CHAT": { "type": "string", "description": "| Тип ограничения `MAX_CHAT`. Возможные значения:" }, "CATEGORY_ENABLE": { "type": "string", "maxLength": 1, "description": "| Включить категории. Возможные значения:" }, "CATEGORY_ID": { "type": "integer", "description": "| Идентификатор категории ||" }, "SESSION_PRIORITY": { "type": "integer", "description": "| Приоритет сессии в очереди ||" }, "WELCOME_BOT_ENABLE": { "type": "string", "maxLength": 1, "description": "| Включить чат-бота приветствия. Возможные значения:" }, "WELCOME_BOT_JOIN": { "type": "string", "description": "| Когда подключать бота. Возможные значения:" }, "WELCOME_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота ||" }, "WELCOME_BOT_TIME": { "type": "integer", "description": "| Через сколько секунд переводить диалог от бота в очередь ||" }, "WELCOME_BOT_LEFT": { "type": "string", "description": "| Когда отключать бота. Возможные значения:" }, "CHECK_AVAILABLE": { "type": "string", "maxLength": 1, "description": "| Проверять доступность оператора при распределении. Возможные значения:" }, "WATCH_TYPING": { "type": "string", "maxLength": 1, "description": "| Показывать индикатор набора текста. Возможные значения:" }, "SEND_WELCOME_EACH_SESSION": { "type": "string", "maxLength": 1, "description": "| Отправлять приветствие в каждой сессии. Возможные значения:" }, "OPERATOR_DATA": { "type": "string", "description": "| Формат данных об операторе. Возможные значения:" }, "DEFAULT_OPERATOR_DATA": { "type": "object", "description": "| Данные оператора по умолчанию. Возможные поля:" }, "NO_ANSWER_RULE": { "type": "string", "description": "| Сценарий, если оператор не ответил. Возможные значения:" }, "NO_ANSWER_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для сценария без ответа ||" }, "NO_ANSWER_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для сценария без ответа ||" }, "NO_ANSWER_TEXT": { "type": "string", "description": "| Текст для сценария без ответа ||" }, "WORKTIME_DAYOFF": { "type": "array", "items": {}, "description": "| Выходные дни. Возможные значения элементов:" }, "WORKTIME_HOLIDAYS": { "type": "string", "description": "| Праздничные дни в формате строки, перечисленные через запятую `DD.MM,DD.MM` ||" }, "WORKTIME_DAYOFF_RULE": { "type": "string", "description": "| Сценарий в нерабочее время. Возможные значения:" }, "WORKTIME_DAYOFF_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для нерабочего времени ||" }, "WORKTIME_DAYOFF_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для нерабочего времени ||" }, "WORKTIME_DAYOFF_TEXT": { "type": "string", "description": "| Текст сообщения в нерабочее время ||" }, "CLOSE_RULE": { "type": "string", "description": "| Сценарий при закрытии. Возможные значения:" }, "CLOSE_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы при закрытии ||" }, "CLOSE_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота при закрытии ||" }, "CLOSE_TEXT": { "type": "string", "description": "| Текст сообщения при закрытии ||" }, "VOTE_TIME_LIMIT": { "type": "integer", "description": "| Лимит времени на голосование ||" }, "VOTE_CLOSING_DELAY": { "type": "string", "maxLength": 1, "description": "| Закрывать сессию сразу после оценки. Возможные значения:" }, "VOTE_BEFORE_FINISH": { "type": "string", "maxLength": 1, "description": "| Запрашивать оценку до завершения. Возможные значения:" }, "VOTE_MESSAGE_1_TEXT": { "type": "string", "description": "| Текст запроса оценки в виджете ||" }, "VOTE_MESSAGE_1_LIKE": { "type": "string", "description": "| Текст после положительной оценки в виджете ||" }, "VOTE_MESSAGE_1_DISLIKE": { "type": "string", "description": "| Текст после отрицательной оценки в виджете ||" }, "VOTE_MESSAGE_2_TEXT": { "type": "string", "description": "| Текст запроса оценки в внешних каналах ||" }, "VOTE_MESSAGE_2_LIKE": { "type": "string", "description": "| Текст после положительной оценки в внешних каналах ||" }, "VOTE_MESSAGE_2_DISLIKE": { "type": "string", "description": "| Текст после отрицательной оценки в внешних каналах ||" }, "AUTO_CLOSE_RULE": { "type": "string", "description": "| Сценарий автозакрытия. Возможные значения:" }, "FULL_CLOSE_TIME": { "type": "integer", "description": "| Время полного закрытия после ручного закрытия ||" }, "AUTO_CLOSE_TIME": { "type": "integer", "description": "| Время до автозакрытия ||" }, "AUTO_CLOSE_FORM_ID": { "type": "integer", "description": "| Идентификатор CRM-формы для автозакрытия ||" }, "AUTO_CLOSE_BOT_ID": { "type": "integer", "description": "| Идентификатор чат-бота для автозакрытия ||" }, "AUTO_CLOSE_TEXT": { "type": "string", "description": "| Текст при автозакрытии ||" }, "AUTO_EXPIRE_TIME": { "type": "integer", "description": "| Срок жизни автоматически закрытой сессии ||" }, "TEMPORARY": { "type": "string", "maxLength": 1, "description": "| Создать временную линию. Возможные значения:" }, "QUICK_ANSWERS_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока быстрых ответов ||" }, "KPI_FIRST_ANSWER_TIME": { "type": "integer", "description": "| Контроль времени первого ответа ||" }, "KPI_FIRST_ANSWER_ALERT": { "type": "string", "maxLength": 1, "description": "| Включить уведомление о первом ответе. Возможные значения:" }, "KPI_FIRST_ANSWER_LIST": { "type": "array", "items": {}, "description": "| Список получателей уведомления о первом ответе ||" }, "KPI_FIRST_ANSWER_TEXT": { "type": "string", "description": "| Текст уведомления о первом ответе ||" }, "KPI_FURTHER_ANSWER_TIME": { "type": "integer", "description": "| Контроль времени последующих ответов ||" }, "KPI_FURTHER_ANSWER_ALERT": { "type": "string", "maxLength": 1, "description": "| Включить уведомление о последующих ответах. Возможные значения:" }, "KPI_FURTHER_ANSWER_LIST": { "type": "array", "items": {}, "description": "| Список получателей уведомления о последующих ответах ||" }, "KPI_FURTHER_ANSWER_TEXT": { "type": "string", "description": "| Текст уведомления о последующих ответах ||" }, "KPI_CHECK_OPERATOR_ACTIVITY": { "type": "string", "maxLength": 1, "description": "| Контролировать активность оператора. Возможные значения:" }, "USE_WELCOME_FORM": { "type": "string", "maxLength": 1, "description": "| Использовать приветственную CRM-форму. Возможные значения:" }, "WELCOME_FORM_ID": { "type": "integer", "description": "| Идентификатор приветственной CRM-формы ||" }, "WELCOME_FORM_DELAY": { "type": "string", "maxLength": 1, "description": "| Показывать форму с задержкой. Возможные значения:" }, "CONFIRM_CLOSE": { "type": "string", "maxLength": 1, "description": "| Запрашивать подтверждение закрытия. Возможные значения:" }, "IGNORE_WELCOME_FORM_RESPONSIBLE": { "type": "string", "maxLength": 1, "description": "| Игнорировать ответственного в приветственной форме. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.delete": { "post": { "summary": "Удалить открытую линию imopenlines.config.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.delete` удаляет открытую линию.", "operationId": "imopenlines_config_delete", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.get": { "post": { "summary": "Получить открытую линию по идентификатору imopenlines.config.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.get` получает настройки открытой линии по идентификатору.", "operationId": "imopenlines_config_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." }, "WITH_QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать данные очереди операторов. Возможные значения:" }, "SHOW_OFFLINE": { "type": "string", "maxLength": 1, "description": "| Возвращать офлайн-операторов в очереди. Возможные значения:" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." }, "WITH_QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать данные очереди операторов. Возможные значения:" }, "SHOW_OFFLINE": { "type": "string", "maxLength": 1, "description": "| Возвращать офлайн-операторов в очереди. Возможные значения:" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.list.get": { "post": { "summary": "Получить список открытых линий imopenlines.config.list.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.list.get` получает список открытых линий.", "operationId": "imopenlines_config_list_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-list-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Параметры выборки (подробное описание)" }, "OPTIONS": { "type": "object", "description": "| Дополнительные опции (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "order": { "type": "object", "description": "| Объект для сортировки списка открытых линий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "filter": { "type": "object", "description": "| Объект для фильтрации списка открытых линий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "limit": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" }, "offset": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" }, "QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать очередь операторов. Возможные значения:" }, "CONFIG_QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать очередь линии. Каждый элемент очереди содержит `ENTITY_TYPE` и `ENTITY_ID`. Возможные значения:" }, "CHECK_PERMISSION": { "type": "string", "description": "| Проверять доступ к линиям по указанному действию из карты прав открытых линий ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Параметры выборки (подробное описание)" }, "OPTIONS": { "type": "object", "description": "| Дополнительные опции (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "order": { "type": "object", "description": "| Объект для сортировки списка открытых линий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "filter": { "type": "object", "description": "| Объект для фильтрации списка открытых линий в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "limit": { "type": "integer", "description": "| Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200` ||" }, "offset": { "type": "integer", "description": "| Смещение для постраничной выборки. По умолчанию: `0` ||" }, "QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать очередь операторов. Возможные значения:" }, "CONFIG_QUEUE": { "type": "string", "maxLength": 1, "description": "| Возвращать очередь линии. Каждый элемент очереди содержит `ENTITY_TYPE` и `ENTITY_ID`. Возможные значения:" }, "CHECK_PERMISSION": { "type": "string", "description": "| Проверять доступ к линиям по указанному действию из карты прав открытых линий ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.path.get": { "post": { "summary": "Получить ссылку на публичную страницу открытых линий imopenlines.config.path.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.path.get` получает ссылку на публичную страницу открытых линий портала.", "operationId": "imopenlines_config_path_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-path-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.update": { "post": { "summary": "Изменить открытую линию imopenlines.config.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.config.update` изменяет открытую линию.", "operationId": "imopenlines_config_update", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-config-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." }, "PARAMS": { "type": "object", "description": "| Объект с настройками для обновления. Набор полей соответствует параметру PARAMS метода `imopenlines.config.add` ||" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор открытой линии." }, "PARAMS": { "type": "object", "description": "| Объект с настройками для обновления. Набор полей соответствует параметру PARAMS метода `imopenlines.config.add` ||" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.get": { "post": { "summary": "Получить чаты для объекта CRM imopenlines.crm.chat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.chat.get` получает список чатов, которые привязаны к объекту CRM.", "operationId": "imopenlines_crm_chat_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "ACTIVE_ONLY": { "type": "string", "maxLength": 1, "description": "| Флаг возврата только активных чатов. Возможные значения:" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "ACTIVE_ONLY": { "type": "string", "maxLength": 1, "description": "| Флаг возврата только активных чатов. Возможные значения:" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.getLastId": { "post": { "summary": "Получить идентификатор последнего чата imopenlines.crm.chat.getLastId", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.chat.getLastId` получает идентификатор последнего чата, который привязан к объекту CRM.", "operationId": "imopenlines_crm_chat_getLastId", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get-last-id.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.user.add": { "post": { "summary": "Добавить пользователя к существующему чату imopenlines.crm.chat.user.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.chat.user.add` добавляет пользователя в чат, привязанный к объекту CRM.", "operationId": "imopenlines_crm_chat_user_add", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя или бота, которого нужно добавить в чат." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя или бота, которого нужно добавить в чат." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.user.delete": { "post": { "summary": "Удалить пользователя из чата imopenlines.crm.chat.user.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.chat.user.delete` удаляет пользователя из чата, привязанного к объекту CRM.", "operationId": "imopenlines_crm_chat_user_delete", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя или бота, которого нужно удалить из чата." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM. Возможные значения:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор объекта CRM." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя или бота, которого нужно удалить из чата." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.lead.create": { "post": { "summary": "Создать лид на основании диалога imopenlines.crm.lead.create", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.lead.create` создает лид CRM по текущему чату открытой линии.", "operationId": "imopenlines_crm_lead_create", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-crm-lead-create.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.message.add": { "post": { "summary": "Отправить сообщение в открытую линию imopenlines.crm.message.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.crm.message.add` отправляет сообщение от имени сотрудника или бота в чат, который привязан к элементу CRM.", "operationId": "imopenlines_crm_message_add", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/messages/imopenlines-crm-message-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязан чат." }, "USER_ID": { "type": "integer", "description": "| Идентификатор отправителя сообщения — пользователя или бота, который должен быть участником чата и иметь доступ к элементу CRM." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии, который связан с элементом CRM." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения, который будет отображен в чате ||" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID", "CHAT_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM:" }, "CRM_ENTITY": { "type": "integer", "description": "| Идентификатор элемента CRM, к которому привязан чат." }, "USER_ID": { "type": "integer", "description": "| Идентификатор отправителя сообщения — пользователя или бота, который должен быть участником чата и иметь доступ к элементу CRM." }, "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии, который связан с элементом CRM." }, "MESSAGE": { "type": "string", "description": "| Текст сообщения, который будет отображен в чате ||" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID", "CHAT_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.dialog.get": { "post": { "summary": "Получить информацию о диалоге оператора imopenlines.dialog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.dialog.get` возвращает данные чата открытой линии. Достаточно передать один из параметров.", "operationId": "imopenlines_dialog_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-dialog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chat`, где `` — идентификатор чата открытой линии ||" }, "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии." }, "USER_CODE": { "type": "string", "description": "| Строковый код пользователя для канала внешней системы." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "DIALOG_ID": { "type": "string", "description": "| Идентификатор диалога в формате `chat`, где `` — идентификатор чата открытой линии ||" }, "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии." }, "USER_CODE": { "type": "string", "description": "| Строковый код пользователя для канала внешней системы." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.message.quick.save": { "post": { "summary": "Сохранить сообщение в качестве быстрого ответа imopenlines.message.quick.save", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.message.quick.save` сохраняет сообщение из чата открытой линии в список быстрых ответов.", "operationId": "imopenlines_message_quick_save", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/messages/imopenlines-message-quick-save.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии, из которого нужно сохранить сообщение." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно добавить в быстрые ответы." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии, из которого нужно сохранить сообщение." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения, которое нужно добавить в быстрые ответы." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.message.session.start": { "post": { "summary": "Начать новый диалог на основании сообщения imopenlines.message.session.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.message.session.start` запускает новую сессию и переносит в нее указанное сообщение.", "operationId": "imopenlines_message_session_start", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-message-session-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения внутри чата." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "MESSAGE_ID": { "type": "integer", "description": "| Идентификатор сообщения внутри чата." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.network.join": { "post": { "summary": "Подключить внешнюю открытую линию к порталу imopenlines.network.join", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.network.join` подключает к текущему Битрикс24 внешнюю открытую линию с другого Битрикс24.", "operationId": "imopenlines_network_join", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-network-join.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код открытой линии в виде строки из 32 символов." } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код открытой линии в виде строки из 32 символов." } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.network.message.add": { "post": { "summary": "Отправить сообщение пользователю от имени открытой линии imopenlines.network.message.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.network.message.add` отправляет сообщение пользователю от имени открытой линии, подключенной в Битрикс24 Network.", "operationId": "imopenlines_network_message_add", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-network-message-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код открытой линии, строка из 32 символов, например `ab515f5d85a8b844d484f6ea75a2e494` ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор получателя сообщения, например `2` ||" }, "MESSAGE": { "type": "string", "description": "| Текст сообщения." }, "ATTACH": { "type": "object", "description": "| Вложение." }, "KEYBOARD": { "type": "object", "description": "| Клавиатура." }, "URL_PREVIEW": { "type": "string", "maxLength": 1, "description": "| Предпросмотр ссылок. Включен `Y` по умолчанию." } }, "required": [ "CODE", "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код открытой линии, строка из 32 символов, например `ab515f5d85a8b844d484f6ea75a2e494` ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор получателя сообщения, например `2` ||" }, "MESSAGE": { "type": "string", "description": "| Текст сообщения." }, "ATTACH": { "type": "object", "description": "| Вложение." }, "KEYBOARD": { "type": "object", "description": "| Клавиатура." }, "URL_PREVIEW": { "type": "string", "maxLength": 1, "description": "| Предпросмотр ссылок. Включен `Y` по умолчанию." } }, "required": [ "CODE", "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.another.finish": { "post": { "summary": "Завершить диалог другого оператора imopenlines.operator.another.finish", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.another.finish` завершает диалог открытой линии, даже если диалог закреплен за другим оператором.", "operationId": "imopenlines_operator_another_finish", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-another-finish.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.answer": { "post": { "summary": "Забрать диалог себе imopenlines.operator.answer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.answer` передает диалог открытой линии текущему оператору.", "operationId": "imopenlines_operator_answer", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-answer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.finish": { "post": { "summary": "Завершить свой диалог imopenlines.operator.finish", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.finish` завершает диалог открытой линии от имени текущего оператора.", "operationId": "imopenlines_operator_finish", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-finish.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.skip": { "post": { "summary": "Пропустить диалог imopenlines.operator.skip", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.skip` передает текущий диалог следующему оператору в очереди.", "operationId": "imopenlines_operator_skip", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-skip.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.spam": { "post": { "summary": "Отметить диалог в качестве «спама» imopenlines.operator.spam", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.spam` помечает диалог открытой линии как спам и завершает его.", "operationId": "imopenlines_operator_spam", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-spam.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.transfer": { "post": { "summary": "Передать диалог другому оператору или в другую линию imopenlines.operator.transfer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.operator.transfer` передает диалог другому оператору или в очередь другой открытой линии.", "operationId": "imopenlines_operator_transfer", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/operators/imopenlines-operator-transfer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Универсальный параметр для передачи диалога." }, "USER_ID": { "type": "integer", "description": "| Идентификатор оператора, которому нужно передать диалог." }, "QUEUE_ID": { "type": "integer", "description": "| Идентификатор линии, в очередь которой нужно передать диалог." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Универсальный параметр для передачи диалога." }, "USER_ID": { "type": "integer", "description": "| Идентификатор оператора, которому нужно передать диалог." }, "QUEUE_ID": { "type": "integer", "description": "| Идентификатор линии, в очередь которой нужно передать диалог." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.revision.get": { "post": { "summary": "Получить информацию о ревизиях API imopenlines.revision.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.revision.get` получает информацию о ревизиях API Открытых линий.", "operationId": "imopenlines_revision_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/imopenlines-revision-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.head.vote": { "post": { "summary": "Поставить оценку работе сотрудника в диалоге imopenlines.session.head.vote", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.head.vote` сохраняет оценку руководителя и комментарий по завершенному диалогу.", "operationId": "imopenlines_session_head_vote", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-head-vote.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии." }, "RATING": { "type": "integer", "description": "| Оценка руководителя. Передайте значение от `1` до `5` ||" }, "COMMENT": { "type": "string", "description": "| Комментарий руководителя к оценке ||" } }, "required": [ "SESSION_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии." }, "RATING": { "type": "integer", "description": "| Оценка руководителя. Передайте значение от `1` до `5` ||" }, "COMMENT": { "type": "string", "description": "| Комментарий руководителя к оценке ||" } }, "required": [ "SESSION_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.history.get": { "post": { "summary": "Получить историю сообщений диалога imopenlines.session.history.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.history.get` возвращает историю сообщений сессии открытой линии.", "operationId": "imopenlines_session_history_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-history-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии открытой линии." }, "CHAT_ID": { "type": "integer", "description": "| Числовой идентификатор чата открытой линии без префикса `chat`. Например, `1763`, не `chat1763`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии открытой линии." }, "CHAT_ID": { "type": "integer", "description": "| Числовой идентификатор чата открытой линии без префикса `chat`. Например, `1763`, не `chat1763`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.intercept": { "post": { "summary": "Забрать диалог у текущего оператора imopenlines.session.intercept", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.intercept` переводит текущий диалог на оператора, который вызывает метод.", "operationId": "imopenlines_session_intercept", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-intercept.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.join": { "post": { "summary": "Присоединиться к диалогу imopenlines.session.join", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.join` добавляет текущего оператора в активный диалог открытой линии.", "operationId": "imopenlines_session_join", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-join.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.pin": { "post": { "summary": "Закрепить или открепить диалог imopenlines.session.mode.pin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.mode.pin` закрепляет или открепляет диалог за текущим оператором.", "operationId": "imopenlines_session_mode_pin", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "ACTIVATE": { "type": "string", "description": "| Флаг закрепления:" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "ACTIVATE": { "type": "string", "description": "| Флаг закрепления:" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.pinAll": { "post": { "summary": "Закрепить все доступные диалоги за оператором imopenlines.session.mode.pinAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.mode.pinAll` закрепляет за текущим оператором все доступные активные диалоги.", "operationId": "imopenlines_session_mode_pinAll", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.silent": { "post": { "summary": "Переключить диалог в скрытый режим imopenlines.session.mode.silent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.mode.silent` включает или выключает режим скрытой переписки в диалоге.", "operationId": "imopenlines_session_mode_silent", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-silent.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "ACTIVATE": { "type": "string", "description": "| Флаг активации режима. `Y` — включить скрытый режим, любое другое значение выключает. По умолчанию режим выключен ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." }, "ACTIVATE": { "type": "string", "description": "| Флаг активации режима. `Y` — включить скрытый режим, любое другое значение выключает. По умолчанию режим выключен ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.unpinAll": { "post": { "summary": "Открепить все закрепленные диалоги оператора imopenlines.session.mode.unpinAll", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.mode.unpinAll` открепляет от текущего оператора все доступные закрепленные диалоги.", "operationId": "imopenlines_session_mode_unpinAll", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-unpin-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.open": { "post": { "summary": "Получить чат по коду пользователя imopenlines.session.open", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.open` возвращает идентификатор чата открытой линии по коду пользователя `USER_CODE`.", "operationId": "imopenlines_session_open", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-open.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_CODE": { "type": "string", "description": "| Строковый код пользователя для канала внешней системы." } }, "required": [ "USER_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_CODE": { "type": "string", "description": "| Строковый код пользователя для канала внешней системы." } }, "required": [ "USER_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.start": { "post": { "summary": "Начать новый диалог imopenlines.session.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.session.start` запускает новую сессию в текущем чате открытой линии.", "operationId": "imopenlines_session_start", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/sessions/imopenlines-session-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Идентификатор чата открытой линии." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Operator.list": { "post": { "summary": "Получить список операторов imopenlines.v2.Operator.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Operator.list` получает список операторов с текущим статусом и нагрузкой.", "operationId": "imopenlines_v2_Operator_list", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-operator-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "userId": { "type": "integer", "description": "| Идентификатор оператора." }, "userIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "status": { "type": "string", "description": "| Статус оператора." }, "hasFreeSlots": { "type": "boolean", "description": "| Фильтр по наличию свободных слотов." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "userId": { "type": "integer", "description": "| Идентификатор оператора." }, "userIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "status": { "type": "string", "description": "| Статус оператора." }, "hasFreeSlots": { "type": "boolean", "description": "| Фильтр по наличию свободных слотов." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Session.Rating.list": { "post": { "summary": "Получить список оценок imopenlines.v2.Session.Rating.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Session.Rating.list` получает список сессий, которым клиент поставил оценку.", "operationId": "imopenlines_v2_Session_Rating_list", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-session-rating-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dateVoteFrom": { "type": "string", "description": "| Начало периода клиентской оценки в формате ISO 8601 ||" }, "dateVoteTo": { "type": "string", "description": "| Конец периода клиентской оценки в формате ISO 8601." }, "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "vote": { "type": "string", "description": "| Клиентская оценка." }, "hasVoteHead": { "type": "boolean", "description": "| Фильтр по наличию оценки руководителя." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } }, "required": [ "dateVoteFrom", "dateVoteTo" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dateVoteFrom": { "type": "string", "description": "| Начало периода клиентской оценки в формате ISO 8601 ||" }, "dateVoteTo": { "type": "string", "description": "| Конец периода клиентской оценки в формате ISO 8601." }, "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "vote": { "type": "string", "description": "| Клиентская оценка." }, "hasVoteHead": { "type": "boolean", "description": "| Фильтр по наличию оценки руководителя." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } }, "required": [ "dateVoteFrom", "dateVoteTo" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Session.Stat.get": { "post": { "summary": "Получить метрики сессий imopenlines.v2.Session.Stat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Session.Stat.get` получает пакетные метрики по сессиям открытых линий.", "operationId": "imopenlines_v2_Session_Stat_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-session-stat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "| Массив идентификаторов сессий." } }, "required": [ "sessionId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "| Массив идентификаторов сессий." } }, "required": [ "sessionId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Session.Transfer.list": { "post": { "summary": "Получить историю переводов imopenlines.v2.Session.Transfer.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Session.Transfer.list` получает историю переводов по сессиям открытых линий.", "operationId": "imopenlines_v2_Session_Transfer_list", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-session-transfer-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "| Массив идентификаторов сессий." } }, "required": [ "sessionId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "| Массив идентификаторов сессий." } }, "required": [ "sessionId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Session.list": { "post": { "summary": "Получить список сессий imopenlines.v2.Session.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Session.list` получает список сессий открытых линий с фильтрами и пагинацией.", "operationId": "imopenlines_v2_Session_list", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-session-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "status": { "type": "string", "description": "| Статус сессии." }, "closeReason": { "type": "string", "description": "| Причина закрытия." }, "dateCreateFrom": { "type": "string", "description": "| Начало периода создания в формате ISO 8601 ||" }, "dateCreateTo": { "type": "string", "description": "| Конец периода создания в формате ISO 8601." }, "dateCloseFrom": { "type": "string", "description": "| Начало периода закрытия в формате ISO 8601 ||" }, "dateCloseTo": { "type": "string", "description": "| Конец периода закрытия в формате ISO 8601." }, "vote": { "type": "string", "description": "| Клиентская оценка." }, "hasVoteHead": { "type": "boolean", "description": "| Фильтр по наличию оценки руководителя." }, "kpiFirstAnswer": { "type": "boolean", "description": "| Фильтр по выполнению KPI первого ответа." }, "hasCrm": { "type": "boolean", "description": "| Фильтр по наличию доступной связи с CRM." }, "waitAnswerFrom": { "type": "integer", "description": "| Минимальное время до первого ответа, секунды ||" }, "waitAnswerTo": { "type": "integer", "description": "| Максимальное время до первого ответа, секунды ||" }, "waitCloseFrom": { "type": "integer", "description": "| Минимальное время до закрытия, секунды ||" }, "waitCloseTo": { "type": "integer", "description": "| Максимальное время до закрытия, секунды ||" }, "order": { "type": "string", "description": "| Поле сортировки." }, "orderDirection": { "type": "string", "description": "| Направление сортировки." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "status": { "type": "string", "description": "| Статус сессии." }, "closeReason": { "type": "string", "description": "| Причина закрытия." }, "dateCreateFrom": { "type": "string", "description": "| Начало периода создания в формате ISO 8601 ||" }, "dateCreateTo": { "type": "string", "description": "| Конец периода создания в формате ISO 8601." }, "dateCloseFrom": { "type": "string", "description": "| Начало периода закрытия в формате ISO 8601 ||" }, "dateCloseTo": { "type": "string", "description": "| Конец периода закрытия в формате ISO 8601." }, "vote": { "type": "string", "description": "| Клиентская оценка." }, "hasVoteHead": { "type": "boolean", "description": "| Фильтр по наличию оценки руководителя." }, "kpiFirstAnswer": { "type": "boolean", "description": "| Фильтр по выполнению KPI первого ответа." }, "hasCrm": { "type": "boolean", "description": "| Фильтр по наличию доступной связи с CRM." }, "waitAnswerFrom": { "type": "integer", "description": "| Минимальное время до первого ответа, секунды ||" }, "waitAnswerTo": { "type": "integer", "description": "| Максимальное время до первого ответа, секунды ||" }, "waitCloseFrom": { "type": "integer", "description": "| Минимальное время до закрытия, секунды ||" }, "waitCloseTo": { "type": "integer", "description": "| Максимальное время до закрытия, секунды ||" }, "order": { "type": "string", "description": "| Поле сортировки." }, "orderDirection": { "type": "string", "description": "| Направление сортировки." }, "offset": { "type": "integer", "description": "| Смещение для пагинации." }, "limit": { "type": "integer", "description": "| Размер страницы." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.v2.Stat.get": { "post": { "summary": "Получить агрегированную статистику imopenlines.v2.Stat.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `imopenlines.v2.Stat.get` получает агрегированную статистику открытых линий за период.", "operationId": "imopenlines_v2_Stat_get", "tags": [ "Открытые линии" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/imopenlines/statistics/imopenlines-v2-stat-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dateFrom": { "type": "string", "description": "| Начало периода в формате ISO 8601 ||" }, "dateTo": { "type": "string", "description": "| Конец периода в формате ISO 8601." }, "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." } }, "required": [ "dateFrom", "dateTo" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dateFrom": { "type": "string", "description": "| Начало периода в формате ISO 8601 ||" }, "dateTo": { "type": "string", "description": "| Конец периода в формате ISO 8601." }, "configId": { "type": "integer", "description": "| Идентификатор открытой линии." }, "configIdList": { "type": "string", "description": "| Список идентификаторов открытых линий." }, "source": { "type": "string", "description": "| Код канала." }, "sourceList": { "type": "string", "description": "| Список кодов каналов." }, "operatorId": { "type": "integer", "description": "| Идентификатор оператора." }, "operatorIdList": { "type": "string", "description": "| Список идентификаторов операторов." } }, "required": [ "dateFrom", "dateTo" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/landing.block.addcard": { "post": { "summary": "Добавить карточку блока landing.block.addcard", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.addcard` добавляет карточку в блок в черновике страницы.", "operationId": "landing_block_addcard", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-add-card.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "selector": { "type": "string", "description": "| Селектор карточки из ключа `cards` манифеста блока" }, "content": { "type": "string", "description": "| HTML новой карточки." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "selector": { "type": "string", "description": "| Селектор карточки из ключа `cards` манифеста блока" }, "content": { "type": "string", "description": "| HTML новой карточки." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector", "content" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.changeAnchor": { "post": { "summary": "Изменить якорь блока landing.block.changeAnchor", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.changeAnchor` изменяет или удаляет пользовательский якорь блока в черновике страницы.", "operationId": "landing_block_changeAnchor", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-change-anchor.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "data": { "type": "string", "description": "| Новый якорь блока без символа `#`." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять изменение в историю страницы." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "data": { "type": "string", "description": "| Новый якорь блока без символа `#`." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять изменение в историю страницы." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.changeNodeName": { "post": { "summary": "Изменить HTML-тег элемента блока landing.block.changeNodeName", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.changeNodeName` изменяет HTML-тег элемента блока в черновике страницы.", "operationId": "landing_block_changeNodeName", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-change-node-name.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы" }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы" }, "data": { "type": "object", "description": "| Набор изменений для элементов блока (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит действие в историю изменений страницы" } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы" }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы" }, "data": { "type": "object", "description": "| Набор изменений для элементов блока (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит действие в историю изменений страницы" } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.clonecard": { "post": { "summary": "Клонировать карточку блока landing.block.clonecard", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.clonecard` создает копию карточки в блоке в черновике страницы. Он работает с карточками, описанными в ключе `cards` манифеста блока.", "operationId": "landing_block_clonecard", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-clone-card.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "selector": { "type": "string", "description": "| Селектор карточки из ключа cards манифеста блока." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "selector": { "type": "string", "description": "| Селектор карточки из ключа cards манифеста блока." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getContentFromRepository": { "post": { "summary": "Получить контент блока из репозитория landing.block.getContentFromRepository", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getContentFromRepository` возвращает HTML-содержимое блока из репозитория.", "operationId": "landing_block_getContentFromRepository", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-content-from-repository.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код блока, содержимое которого нужно получить." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код блока, содержимое которого нужно получить." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getbyid": { "post": { "summary": "Получить блок по идентификатору landing.block.getbyid", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getbyid` возвращает один блок страницы по его идентификатору.", "operationId": "landing_block_getbyid", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-by-id.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения блока (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии." }, "deleted": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод ищет блоки, помеченные как удаленные." }, "get_content": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в `result` дополнительно возвращаются поля `content`, `css` и `js`." } }, "required": [ "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения блока (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии." }, "deleted": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод ищет блоки, помеченные как удаленные." }, "get_content": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в `result` дополнительно возвращаются поля `content`, `css` и `js`." } }, "required": [ "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getcontent": { "post": { "summary": "Получить контент блока landing.block.getcontent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getcontent` возвращает готовый HTML блока, его ресурсы, манифест и служебные свойства блока.", "operationId": "landing_block_getcontent", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-content.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "editMode": { "type": "boolean", "description": "| Режим получения версии блока." }, "params": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "wrapper_show": { "type": "boolean", "description": "| Возвращать ли в `result.content` внешний контейнер блока `
`." }, "force_unactive": { "type": "boolean", "description": "| Формировать HTML даже для неактивного блока." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "editMode": { "type": "boolean", "description": "| Режим получения версии блока." }, "params": { "type": "object", "description": "| Дополнительные параметры (подробное описание) ||" }, "wrapper_show": { "type": "boolean", "description": "| Возвращать ли в `result.content` внешний контейнер блока `
`." }, "force_unactive": { "type": "boolean", "description": "| Формировать HTML даже для неактивного блока." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getlist": { "post": { "summary": "Получить список блоков страницы landing.block.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getlist` возвращает список блоков выбранной страницы.", "operationId": "landing_block_getlist", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "\\| [`integer[]`](../../../data-types.md) | Идентификатор страницы или массив идентификаторов страниц." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения списка (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии." }, "deleted": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод возвращает только блоки, помеченные как удаленные." }, "get_content": { "type": "boolean", "description": "\\| `integer` | Если передать `true`, метод добавит в каждый элемент результата поля `content`, `css` и `js`. По умолчанию — `false`." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "\\| [`integer[]`](../../../data-types.md) | Идентификатор страницы или массив идентификаторов страниц." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения списка (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии." }, "deleted": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод возвращает только блоки, помеченные как удаленные." }, "get_content": { "type": "boolean", "description": "\\| `integer` | Если передать `true`, метод добавит в каждый элемент результата поля `content`, `css` и `js`. По умолчанию — `false`." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getmanifest": { "post": { "summary": "Получить манифест блока landing.block.getmanifest", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getmanifest` возвращает подготовленный манифест блока, размещенного на странице.", "operationId": "landing_block_getmanifest", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-manifest.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока. Блок должен принадлежать странице `lid` в выбранной версии страницы." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения манифеста (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии. По умолчанию — `false`." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока. Блок должен принадлежать странице `lid` в выбранной версии страницы." }, "params": { "type": "object", "description": "| Дополнительные параметры чтения манифеста (подробное описание) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, метод читает черновик страницы вместо опубликованной версии. По умолчанию — `false`." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getmanifestfile": { "post": { "summary": "Получить файл манифеста блока landing.block.getmanifestfile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getmanifestfile` возвращает исходный манифест блока из файлового репозитория.", "operationId": "landing_block_getmanifestfile", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-manifest-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код блока из файлового репозитория." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код блока из файлового репозитория." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getrepository": { "post": { "summary": "Получить список блоков из репозитория landing.block.getrepository", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.getrepository` возвращает доступные разделы репозитория блоков или данные одного раздела.", "operationId": "landing_block_getrepository", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-get-repository.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "section": { "type": "string", "description": "| Код раздела репозитория, например `text`." }, "scope": { "type": "string", "description": "| Дополнительный верхнеуровневый параметр REST-вызова, который влияет на тип сайта, для которого собирается репозиторий." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "section": { "type": "string", "description": "| Код раздела репозитория, например `text`." }, "scope": { "type": "string", "description": "| Дополнительный верхнеуровневый параметр REST-вызова, который влияет на тип сайта, для которого собирается репозиторий." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.publication": { "post": { "summary": "Опубликовать блок landing.block.publication", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.publication` публикует один блок страницы.", "operationId": "landing_block_publication", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-publication.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." } }, "required": [ "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." } }, "required": [ "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.removecard": { "post": { "summary": "Удалить карточку блока landing.block.removecard", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.removecard` удаляет карточку из блока в черновике страницы.", "operationId": "landing_block_removecard", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-remove-card.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "selector": { "type": "string", "description": "| Селектор карточки из раздела `cards` манифеста блока" }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "selector": { "type": "string", "description": "| Селектор карточки из раздела `cards` манифеста блока" }, "preventHistory": { "type": "boolean", "description": "| Не добавлять действие в историю изменений страницы." } }, "required": [ "lid", "block", "selector" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateCards": { "post": { "summary": "Обновить карточки блока landing.block.updateCards", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.updateCards` обновляет набор карточек блока и ноды внутри этих карточек в черновике страницы.", "operationId": "landing_block_updateCards", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-update-cards.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "data": { "type": "object", "description": "| Набор изменений для карточек блока (подробное описание) ||" }, "source": { "type": "array", "items": {}, "description": "| Определяет итоговый порядок и количество карточек (подробное описание) ||" }, "values": { "type": "array", "items": {}, "description": "| Обновляет ноды внутри карточек после применения `source` (подробное описание) ||" }, "type": { "type": "string", "description": "| Тип источника карточки." }, "value": { "type": "integer", "description": "\\| `string` | Значение источника карточки." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "data": { "type": "object", "description": "| Набор изменений для карточек блока (подробное описание) ||" }, "source": { "type": "array", "items": {}, "description": "| Определяет итоговый порядок и количество карточек (подробное описание) ||" }, "values": { "type": "array", "items": {}, "description": "| Обновляет ноды внутри карточек после применения `source` (подробное описание) ||" }, "type": { "type": "string", "description": "| Тип источника карточки." }, "value": { "type": "integer", "description": "\\| `string` | Значение источника карточки." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateStyles": { "post": { "summary": "Изменить стили блока landing.block.updateStyles", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.updateStyles` обновляет CSS-классы и инлайновые стили элементов блока в черновике страницы.", "operationId": "landing_block_updateStyles", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-update-styles.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Объект формата:" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит изменение в историю страницы." }, "classList": { "type": "array", "items": {}, "description": "| Список CSS-классов элемента после обновления." }, "affect": { "type": "array", "items": {}, "description": "| Список CSS-свойств, которые нужно удалить из инлайновых стилей всех вложенных элементов найденного узла. Например, `[\"text-align\", \"color\"]` ||" }, "style": { "type": "object", "description": "| Набор инлайновых стилей для найденного элемента в формате `{ \"css-property\": \"value\" }`. Метод объединяет переданные значения с текущим атрибутом `style`." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Объект формата:" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит изменение в историю страницы." }, "classList": { "type": "array", "items": {}, "description": "| Список CSS-классов элемента после обновления." }, "affect": { "type": "array", "items": {}, "description": "| Список CSS-свойств, которые нужно удалить из инлайновых стилей всех вложенных элементов найденного узла. Например, `[\"text-align\", \"color\"]` ||" }, "style": { "type": "object", "description": "| Набор инлайновых стилей для найденного элемента в формате `{ \"css-property\": \"value\" }`. Метод объединяет переданные значения с текущим атрибутом `style`." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateattrs": { "post": { "summary": "Изменить атрибуты элементов блока landing.block.updateattrs", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.updateattrs` обновляет атрибуты HTML-элементов внутри блока в черновике страницы.", "operationId": "landing_block_updateattrs", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-update-attrs.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Набор атрибутов для обновления (подробное описание) ||" } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Набор атрибутов для обновления (подробное описание) ||" } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updatecontent": { "post": { "summary": "Изменить контент блока landing.block.updatecontent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.updatecontent` полностью заменяет HTML-содержимое блока в черновике страницы.", "operationId": "landing_block_updatecontent", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-update-content.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "content": { "type": "string", "description": "| Новый HTML блока целиком." }, "designed": { "type": "boolean", "description": "\\| `integer` \\| `string` | Помечает блок как измененный вручную." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять изменение в историю страницы. По умолчанию — `false` ||" } }, "required": [ "lid", "block", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в черновике страницы." }, "content": { "type": "string", "description": "| Новый HTML блока целиком." }, "designed": { "type": "boolean", "description": "\\| `integer` \\| `string` | Помечает блок как измененный вручную." }, "preventHistory": { "type": "boolean", "description": "| Не добавлять изменение в историю страницы. По умолчанию — `false` ||" } }, "required": [ "lid", "block", "content" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updatenodes": { "post": { "summary": "Обновить ноды блока landing.block.updatenodes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.updatenodes` обновляет ноды блока в черновике страницы. Если страница уже опубликована, изменения станут видны посетителям после повторной публикации через интерфейс или методом [landing.landing.publication](../../page/methods/landing-landing-publication.md).", "operationId": "landing_block_updatenodes", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-update-nodes.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Набор изменений для нод блока и параметров компонента, доступных для редактирования (подробное описание) ||" }, "additional": { "type": "object", "description": "| Дополнительные параметры сохранения (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит действие в историю изменений страницы. По умолчанию `false` ||" }, "appendMenu": { "type": "boolean", "description": "| Добавляет новые пункты к текущему меню вместо полной замены. Работает только для блоков, в манифесте которых описан раздел `menu`." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "data": { "type": "object", "description": "| Набор изменений для нод блока и параметров компонента, доступных для редактирования (подробное описание) ||" }, "additional": { "type": "object", "description": "| Дополнительные параметры сохранения (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если передать `true`, метод не добавит действие в историю изменений страницы. По умолчанию `false` ||" }, "appendMenu": { "type": "boolean", "description": "| Добавляет новые пункты к текущему меню вместо полной замены. Работает только для блоков, в манифесте которых описан раздел `menu`." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.uploadfile": { "post": { "summary": "Загрузить и привязать изображение к блоку landing.block.uploadfile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.block.uploadfile` загружает изображение и привязывает его к указанному блоку.", "operationId": "landing_block_uploadfile", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/block/methods/landing-block-upload-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока, к которому нужно привязать изображение." }, "picture": { "type": "string", "description": "\\| [`string[]`](../../../data-types.md) | Изображение для загрузки." }, "ext": { "type": "string", "description": "| Расширение файла для загрузки по URL, если его нельзя точно определить по адресу." }, "params": { "type": "object", "description": "| Дополнительные параметры обработки изображения (подробное описание)." }, "temp": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, файл помечается как временный." }, "width": { "type": "integer", "description": "| Целевая ширина изображения в пикселях." }, "height": { "type": "integer", "description": "| Целевая высота изображения в пикселях." }, "resize_type": { "type": "integer", "description": "| Режим изменения размера." } }, "required": [ "block", "picture" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "block": { "type": "integer", "description": "| Идентификатор блока, к которому нужно привязать изображение." }, "picture": { "type": "string", "description": "\\| [`string[]`](../../../data-types.md) | Изображение для загрузки." }, "ext": { "type": "string", "description": "| Расширение файла для загрузки по URL, если его нельзя точно определить по адресу." }, "params": { "type": "object", "description": "| Дополнительные параметры обработки изображения (подробное описание)." }, "temp": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, файл помечается как временный." }, "width": { "type": "integer", "description": "| Целевая ширина изображения в пикселях." }, "height": { "type": "integer", "description": "| Целевая высота изображения в пикселях." }, "resize_type": { "type": "integer", "description": "| Режим изменения размера." } }, "required": [ "block", "picture" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getList": { "post": { "summary": "Получить список зарегистрированных шаблонов landing.demos.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.demos.getList` получает список зарегистрированных шаблонов.", "operationId": "landing_demos_getList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/demos/landing-demos-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "string", "description": "| Массив формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "group": { "type": "array", "items": {}, "description": "| Массив полей для группировки результата." }, "limit": { "type": "integer", "description": "| Лимит записей в выборке ||" }, "offset": { "type": "integer", "description": "| Смещение записей в выборке ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "string", "description": "| Массив формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "group": { "type": "array", "items": {}, "description": "| Массив полей для группировки результата." }, "limit": { "type": "integer", "description": "| Лимит записей в выборке ||" }, "offset": { "type": "integer", "description": "| Смещение записей в выборке ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getPageList": { "post": { "summary": "Получить список шаблонов для создания страниц landing.demos.getPageList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.demos.getPageList` получает список файловых демо-шаблонов страниц.", "operationId": "landing_demos_getPageList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/demos/landing-demos-get-page-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getSiteList": { "post": { "summary": "Получить список шаблонов для создания сайтов landing.demos.getSiteList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.demos.getSiteList` получает список файловых демо-шаблонов сайтов.", "operationId": "landing_demos_getSiteList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/demos/landing-demos-get-site-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект формата:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.register": { "post": { "summary": "Зарегистрировать шаблон в мастере создания сайта landing.demos.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.demos.register` регистрирует пользовательский шаблон в мастере создания сайта и страниц.", "operationId": "landing_demos_register", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/demos/landing-demos-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Дополнительные параметры регистрации подробнее ||" }, "charset": { "type": "string", "description": "| Кодировка экспортируемого шаблона ||" }, "site_code": { "type": "string", "description": "| Код сайта (путь) ||" }, "description": { "type": "string", "description": "\\| `null` | Описание шаблона ||" }, "type": { "type": "string", "description": "| Тип шаблона." }, "tpl_type": { "type": "string", "description": "| Тип использования шаблона в мастере." }, "fields": { "type": "object", "description": "| Поля сайта из экспорта подробнее ||" }, "folders": { "type": "array", "items": {}, "description": "\\| `object` | Папки из экспорта подробнее ||" }, "items": { "type": "object", "description": "| Карта страниц шаблона в формате `{ \"код_страницы\": items }` подробнее ||" }, "layout": { "type": "array", "items": {}, "description": "\\| `object` | Данные layout из экспорта подробнее ||" }, "preview": { "type": "string", "description": "| Ссылка на preview 1x ||" }, "preview2x": { "type": "string", "description": "| Ссылка на preview 2x ||" }, "preview3x": { "type": "string", "description": "| Ссылка на preview 3x ||" }, "preview_url": { "type": "string", "description": "| Ссылка на предпросмотр ||" }, "show_in_list": { "type": "string", "description": "| Признак показа в списке (`Y`/`N`) ||" }, "syspages": { "type": "array", "items": {}, "description": "\\| `object` | Системные страницы из экспорта подробнее ||" }, "version": { "type": "integer", "description": "| Версия формата экспорта ||" }, "old_id": { "type": "string", "description": "\\| `integer` | Исходный идентификатор страницы ||" }, "code": { "type": "string", "description": "| Код блока ||" }, "access": { "type": "string", "description": "| Уровень доступа к блоку ||" }, "anchor": { "type": "string", "description": "| Якорь блока ||" }, "cards": { "type": "object", "description": "| Карточки блока ||" }, "nodes": { "type": "object", "description": "| Узлы блока ||" }, "style": { "type": "object", "description": "| Стили блока ||" }, "attrs": { "type": "object", "description": "| Атрибуты блока ||" }, "site_template_id": { "type": "string", "description": "| Идентификатор шаблона сайта главного модуля." }, "lang": { "type": "object", "description": "| Локализация основных фраз шаблона." }, "lang_original": { "type": "string", "description": "| Код исходного языка для массива `lang` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Дополнительные параметры регистрации подробнее ||" }, "charset": { "type": "string", "description": "| Кодировка экспортируемого шаблона ||" }, "site_code": { "type": "string", "description": "| Код сайта (путь) ||" }, "description": { "type": "string", "description": "\\| `null` | Описание шаблона ||" }, "type": { "type": "string", "description": "| Тип шаблона." }, "tpl_type": { "type": "string", "description": "| Тип использования шаблона в мастере." }, "fields": { "type": "object", "description": "| Поля сайта из экспорта подробнее ||" }, "folders": { "type": "array", "items": {}, "description": "\\| `object` | Папки из экспорта подробнее ||" }, "items": { "type": "object", "description": "| Карта страниц шаблона в формате `{ \"код_страницы\": items }` подробнее ||" }, "layout": { "type": "array", "items": {}, "description": "\\| `object` | Данные layout из экспорта подробнее ||" }, "preview": { "type": "string", "description": "| Ссылка на preview 1x ||" }, "preview2x": { "type": "string", "description": "| Ссылка на preview 2x ||" }, "preview3x": { "type": "string", "description": "| Ссылка на preview 3x ||" }, "preview_url": { "type": "string", "description": "| Ссылка на предпросмотр ||" }, "show_in_list": { "type": "string", "description": "| Признак показа в списке (`Y`/`N`) ||" }, "syspages": { "type": "array", "items": {}, "description": "\\| `object` | Системные страницы из экспорта подробнее ||" }, "version": { "type": "integer", "description": "| Версия формата экспорта ||" }, "old_id": { "type": "string", "description": "\\| `integer` | Исходный идентификатор страницы ||" }, "code": { "type": "string", "description": "| Код блока ||" }, "access": { "type": "string", "description": "| Уровень доступа к блоку ||" }, "anchor": { "type": "string", "description": "| Якорь блока ||" }, "cards": { "type": "object", "description": "| Карточки блока ||" }, "nodes": { "type": "object", "description": "| Узлы блока ||" }, "style": { "type": "object", "description": "| Стили блока ||" }, "attrs": { "type": "object", "description": "| Атрибуты блока ||" }, "site_template_id": { "type": "string", "description": "| Идентификатор шаблона сайта главного модуля." }, "lang": { "type": "object", "description": "| Локализация основных фраз шаблона." }, "lang_original": { "type": "string", "description": "| Код исходного языка для массива `lang` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.unregister": { "post": { "summary": "Удалить зарегистрированный шаблон landing.demos.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.demos.unregister` удаляет зарегистрированный шаблон по его коду.", "operationId": "landing_demos_unregister", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/demos/landing-demos-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.add": { "post": { "summary": "Добавить страницу или папку landing.landing.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.add` добавляет страницу или папку в указанный сайт и возвращает идентификатор созданного объекта. Новый объект создается неактивным (`ACTIVE = N`).", "operationId": "landing_landing_add", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "fields": { "type": "object", "description": "| Набор полей новой страницы или папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название страницы ||" }, "SITE_ID": { "type": "integer", "description": "| Идентификатор сайта, в котором создается страница." }, "CODE": { "type": "string", "description": "| Символьный код страницы. Он не должен содержать символ `/` и не должен быть в формате `<символы>_<число>_<число>`, например `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Произвольное описание страницы ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор страницы ||" }, "SITEMAP": { "type": "string", "description": "| Флаг включения страницы в карту сайта. Поддерживаются `Y` и `N`, по умолчанию `N` ||" }, "FOLDER": { "type": "string", "description": "| Используется, если вместо страницы нужно создать папку. Поддерживаются `Y` и `N`, по умолчанию `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которой нужно создать страницу. Папка должна принадлежать тому же сайту, что и `SITE_ID`." }, "TPL_ID": { "type": "integer", "description": "| Идентификатор шаблона представления страницы." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля страницы. Доступные коды и значения описаны в статье Дополнительные поля страницы ||" }, "BLOCK_ID": { "type": "integer", "description": "| Вместе с `MENU_CODE` используется, чтобы после создания страницы добавить ссылку в меню блока с указанным идентификатором ||" }, "MENU_CODE": { "type": "string", "description": "| Вместе с `BLOCK_ID` указывает код меню в блоке, куда нужно добавить ссылку на созданную страницу ||" } }, "required": [ "fields", "TITLE", "SITE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "fields": { "type": "object", "description": "| Набор полей новой страницы или папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название страницы ||" }, "SITE_ID": { "type": "integer", "description": "| Идентификатор сайта, в котором создается страница." }, "CODE": { "type": "string", "description": "| Символьный код страницы. Он не должен содержать символ `/` и не должен быть в формате `<символы>_<число>_<число>`, например `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Произвольное описание страницы ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор страницы ||" }, "SITEMAP": { "type": "string", "description": "| Флаг включения страницы в карту сайта. Поддерживаются `Y` и `N`, по умолчанию `N` ||" }, "FOLDER": { "type": "string", "description": "| Используется, если вместо страницы нужно создать папку. Поддерживаются `Y` и `N`, по умолчанию `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которой нужно создать страницу. Папка должна принадлежать тому же сайту, что и `SITE_ID`." }, "TPL_ID": { "type": "integer", "description": "| Идентификатор шаблона представления страницы." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля страницы. Доступные коды и значения описаны в статье Дополнительные поля страницы ||" }, "BLOCK_ID": { "type": "integer", "description": "| Вместе с `MENU_CODE` используется, чтобы после создания страницы добавить ссылку в меню блока с указанным идентификатором ||" }, "MENU_CODE": { "type": "string", "description": "| Вместе с `BLOCK_ID` указывает код меню в блоке, куда нужно добавить ссылку на созданную страницу ||" } }, "required": [ "fields", "TITLE", "SITE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.addByTemplate": { "post": { "summary": "Добавить страницу по шаблону landing.landing.addByTemplate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.addByTemplate` создает страницу в указанном сайте по коду шаблона и возвращает идентификатор созданной страницы. Новая страница создается неактивной (`ACTIVE = N`).", "operationId": "landing_landing_addByTemplate", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-add-by-template.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в котором нужно создать страницу." }, "code": { "type": "string", "description": "| Код шаблона страницы." }, "fields": { "type": "object", "description": "| Дополнительные параметры создания страницы (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Переопределяет заголовок создаваемой страницы и SEO-заголовки шаблона." }, "DESCRIPTION": { "type": "string", "description": "| Переопределяет SEO-описания шаблона." }, "ID": { "type": "integer", "description": "| Идентификатор существующей страницы или папки в том же сайте." }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которой нужно создать страницу. Папка должна относиться к тому же сайту, что и `siteId`, иначе метод вернет ошибку." }, "SITE_TYPE": { "type": "string", "description": "| Тип шаблонов, из которого создается страница. Используются типы сайтов из статьи Работа с типами сайтов и скоупами." }, "ADD_IN_MENU": { "type": "string", "description": "| Флаг добавления созданной страницы в меню сайта. Поддерживаются `Y` и `N`." }, "BLOCK_ID": { "type": "integer", "description": "| Вместе с `MENU_CODE` добавляет ссылку на созданную страницу в меню блока с указанным идентификатором ||" }, "MENU_CODE": { "type": "string", "description": "| Вместе с `BLOCK_ID` указывает код меню внутри блока, куда нужно добавить ссылку на созданную страницу ||" } }, "required": [ "siteId", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в котором нужно создать страницу." }, "code": { "type": "string", "description": "| Код шаблона страницы." }, "fields": { "type": "object", "description": "| Дополнительные параметры создания страницы (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Переопределяет заголовок создаваемой страницы и SEO-заголовки шаблона." }, "DESCRIPTION": { "type": "string", "description": "| Переопределяет SEO-описания шаблона." }, "ID": { "type": "integer", "description": "| Идентификатор существующей страницы или папки в том же сайте." }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которой нужно создать страницу. Папка должна относиться к тому же сайту, что и `siteId`, иначе метод вернет ошибку." }, "SITE_TYPE": { "type": "string", "description": "| Тип шаблонов, из которого создается страница. Используются типы сайтов из статьи Работа с типами сайтов и скоупами." }, "ADD_IN_MENU": { "type": "string", "description": "| Флаг добавления созданной страницы в меню сайта. Поддерживаются `Y` и `N`." }, "BLOCK_ID": { "type": "integer", "description": "| Вместе с `MENU_CODE` добавляет ссылку на созданную страницу в меню блока с указанным идентификатором ||" }, "MENU_CODE": { "type": "string", "description": "| Вместе с `BLOCK_ID` указывает код меню внутри блока, куда нужно добавить ссылку на созданную страницу ||" } }, "required": [ "siteId", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.addblock": { "post": { "summary": "Добавить блок на страницу landing.landing.addblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.addblock` добавляет новый блок на страницу и возвращает идентификатор созданного блока.", "operationId": "landing_landing_addblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-add-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "fields": { "type": "object", "description": "| Набор параметров нового блока (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" }, "CODE": { "type": "string", "description": "| Символьный код блока из репозитория." }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока, после которого нужно вставить новый блок." }, "ACTIVE": { "type": "string", "description": "| Флаг активности нового блока. Возможные значения:" }, "CONTENT": { "type": "string", "description": "| HTML-содержимое блока. Позволяет заменить стандартный контент блока своим HTML-кодом. При этом код блока все равно должен быть доступен в репозитории для текущего типа страницы и `scope`. Перед сохранением значение очищается и проверяется ||" }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, после добавления блока метод вернет объект с данными блока, включая его идентификатор (подробное описание). При любом другом значении метод вернет только идентификатор блока ||" } }, "required": [ "lid", "fields", "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "fields": { "type": "object", "description": "| Набор параметров нового блока (подробное описание) ||" }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" }, "CODE": { "type": "string", "description": "| Символьный код блока из репозитория." }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока, после которого нужно вставить новый блок." }, "ACTIVE": { "type": "string", "description": "| Флаг активности нового блока. Возможные значения:" }, "CONTENT": { "type": "string", "description": "| HTML-содержимое блока. Позволяет заменить стандартный контент блока своим HTML-кодом. При этом код блока все равно должен быть доступен в репозитории для текущего типа страницы и `scope`. Перед сохранением значение очищается и проверяется ||" }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, после добавления блока метод вернет объект с данными блока, включая его идентификатор (подробное описание). При любом другом значении метод вернет только идентификатор блока ||" } }, "required": [ "lid", "fields", "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.copy": { "post": { "summary": "Копировать страницу landing.landing.copy", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.copy` копирует страницу и возвращает идентификатор новой страницы. Метод может копировать в том числе страницу, помеченную как удаленная и находящуюся в корзине.", "operationId": "landing_landing_copy", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-copy.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор исходной страницы." }, "toSiteId": { "type": "integer", "description": "| Идентификатор целевого сайта. Если параметр не передавать или передать `0`, копия будет создана в том же сайте, где находится исходная страница" }, "toFolderId": { "type": "integer", "description": "| Идентификатор целевой папки. Если параметр передан, копия создается в указанной папке. Папка должна относиться к целевому сайту `toSiteId`." }, "skipSystem": { "type": "boolean", "description": "| Флаг копирования системного признака страницы. По умолчанию `false`." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор исходной страницы." }, "toSiteId": { "type": "integer", "description": "| Идентификатор целевого сайта. Если параметр не передавать или передать `0`, копия будет создана в том же сайте, где находится исходная страница" }, "toFolderId": { "type": "integer", "description": "| Идентификатор целевой папки. Если параметр передан, копия создается в указанной папке. Папка должна относиться к целевому сайту `toSiteId`." }, "skipSystem": { "type": "boolean", "description": "| Флаг копирования системного признака страницы. По умолчанию `false`." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.copyblock": { "post": { "summary": "Копировать блок на страницу landing.landing.copyblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.copyblock` копирует блок на указанную страницу и возвращает идентификатор созданной копии блока. Можно копировать блок как с другой страницы, так и в пределах той же страницы. Вместе с блоком копируются его HTML-содержимое.", "operationId": "landing_landing_copyblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-copy-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, на которую нужно скопировать блок." }, "block": { "type": "integer", "description": "| Идентификатор исходного блока." }, "params": { "type": "object", "description": "| Дополнительные параметры копирования (подробное описание) ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока на странице `lid`, после которого нужно вставить копию" }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, метод вернет объект с признаком успеха и данными созданной копии блока (подробное описание). При любом другом значении метод вернет только идентификатор созданной копии блока ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, на которую нужно скопировать блок." }, "block": { "type": "integer", "description": "| Идентификатор исходного блока." }, "params": { "type": "object", "description": "| Дополнительные параметры копирования (подробное описание) ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока на странице `lid`, после которого нужно вставить копию" }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, метод вернет объект с признаком успеха и данными созданной копии блока (подробное описание). При любом другом значении метод вернет только идентификатор созданной копии блока ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.delete": { "post": { "summary": "Удалить страницу landing.landing.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.delete` удаляет страницу вместе с ее блоками и связанными файлами.", "operationId": "landing_landing_delete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.deleteblock": { "post": { "summary": "Удалить блок со страницы landing.landing.deleteblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.deleteblock` полностью удаляет блок со страницы.", "operationId": "landing_landing_deleteblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-delete-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.downblock": { "post": { "summary": "Переместить блок ниже landing.landing.downblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.downblock` перемещает блок на одну позицию вниз в черновике страницы.", "operationId": "landing_landing_downblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-down-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.favoriteBlock": { "post": { "summary": "Сохранить в список блоков landing.landing.favoriteBlock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.favoriteBlock` создает копию блока страницы и сохраняет ее в список блоков как шаблон. При успешном выполнении метод возвращает идентификатор новой копии блока.", "operationId": "landing_landing_favoriteBlock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-favorite-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "meta": { "type": "object", "description": "| Параметры сохраненного блока (подробное описание)." }, "section": { "type": "array", "items": {}, "description": "\\| `string` | Раздел или список разделов, в которых будет показан сохраненный блок. Если параметр не передан, блок будет показан в тех же разделах, что и исходный блок." }, "preview": { "type": "integer", "description": "| Идентификатор файла картинки превью." }, "tpl_code": { "type": "string", "description": "| Код шаблона страницы, с которым нужно связать сохраненный блок." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "meta": { "type": "object", "description": "| Параметры сохраненного блока (подробное описание)." }, "section": { "type": "array", "items": {}, "description": "\\| `string` | Раздел или список разделов, в которых будет показан сохраненный блок. Если параметр не передан, блок будет показан в тех же разделах, что и исходный блок." }, "preview": { "type": "integer", "description": "| Идентификатор файла картинки превью." }, "tpl_code": { "type": "string", "description": "| Код шаблона страницы, с которым нужно связать сохраненный блок." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getList": { "post": { "summary": "Получить список страниц landing.landing.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.getList` получает список страниц по параметрам выборки.", "operationId": "landing_landing_getList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "params": { "type": "object", "description": "| Параметры выборки страниц (подробное описание) ||" }, "select": { "type": "string", "description": "| Список полей для выборки из полей объекта Страница. Если параметр не передан или равен `null`, используется `[\"*\"]`." }, "filter": { "type": "object", "description": "| Фильтр по полям из полей объекта Страница. Если параметр не передан или передан в неверном формате, выборка выполняется без пользовательских условий. Ключи с `.` и `CHECK_PERMISSIONS` игнорируются." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC\"}` или `{\"FIELD\": \"DESC\"}`. Если параметр не передан, специальная сортировка не применяется ||" }, "group": { "type": "array", "items": {}, "description": "| Группировка в формате ORM. Собственного значения по умолчанию у метода нет ||" }, "limit": { "type": "integer", "description": "| Ограничение количества строк выборки на уровне ORM. Метод не задает собственный лимит по умолчанию ||" }, "offset": { "type": "integer", "description": "| Смещение выборки на уровне ORM ||" }, "get_preview": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `PREVIEW` со ссылкой на превью страницы ||" }, "get_urls": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `PUBLIC_URL` с публичным адресом страницы ||" }, "check_area": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `IS_AREA`, которое показывает, является ли страница включаемой областью ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "params": { "type": "object", "description": "| Параметры выборки страниц (подробное описание) ||" }, "select": { "type": "string", "description": "| Список полей для выборки из полей объекта Страница. Если параметр не передан или равен `null`, используется `[\"*\"]`." }, "filter": { "type": "object", "description": "| Фильтр по полям из полей объекта Страница. Если параметр не передан или передан в неверном формате, выборка выполняется без пользовательских условий. Ключи с `.` и `CHECK_PERMISSIONS` игнорируются." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC\"}` или `{\"FIELD\": \"DESC\"}`. Если параметр не передан, специальная сортировка не применяется ||" }, "group": { "type": "array", "items": {}, "description": "| Группировка в формате ORM. Собственного значения по умолчанию у метода нет ||" }, "limit": { "type": "integer", "description": "| Ограничение количества строк выборки на уровне ORM. Метод не задает собственный лимит по умолчанию ||" }, "offset": { "type": "integer", "description": "| Смещение выборки на уровне ORM ||" }, "get_preview": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `PREVIEW` со ссылкой на превью страницы ||" }, "get_urls": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `PUBLIC_URL` с публичным адресом страницы ||" }, "check_area": { "type": "boolean", "description": "\\| `integer` | Если значение приводится к `true`, в каждый элемент результата добавляется поле `IS_AREA`, которое показывает, является ли страница включаемой областью ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getadditionalfields": { "post": { "summary": "Получить дополнительные поля страницы landing.landing.getadditionalfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.getadditionalfields` получает [дополнительные поля](../additional-fields.md) страницы.", "operationId": "landing_landing_getadditionalfields", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-get-additional-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getpreview": { "post": { "summary": "Получить URL превью страницы landing.landing.getpreview", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.getpreview` возвращает URL или относительный путь до изображения превью страницы.", "operationId": "landing_landing_getpreview", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-get-preview.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getpublicurl": { "post": { "summary": "Получить публичный URL страницы landing.landing.getpublicurl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.getpublicurl` возвращает полный публичный URL страницы.", "operationId": "landing_landing_getpublicurl", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-get-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.hideblock": { "post": { "summary": "Скрыть блок на странице landing.landing.hideblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.hideblock` скрывает блок на странице. Скрытый блок остается в черновике страницы и его можно снова показать методом [landing.landing.showblock](./landing-landing-show-block.md).", "operationId": "landing_landing_hideblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-hide-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markDelete": { "post": { "summary": "Пометить страницу как удаленную landing.landing.markDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.markDelete` помечает страницу как удаленную, переносит ее в корзину и снимает с публикации.", "operationId": "landing_landing_markDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-mark-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "mark": { "type": "boolean", "description": "| Признак пометки страницы как удаленной. По умолчанию `true`." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "mark": { "type": "boolean", "description": "| Признак пометки страницы как удаленной. По умолчанию `true`." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markUnDelete": { "post": { "summary": "Восстановить страницу из корзины landing.landing.markUnDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.markUnDelete` восстанавливает страницу из корзины и снимает признак удаления.", "operationId": "landing_landing_markUnDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-mark-undelete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markdeletedblock": { "post": { "summary": "Отметить блок как удаленный landing.landing.markdeletedblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.markdeletedblock` помечает блок страницы как удаленный, но не удаляет его из базы данных. Помеченный блок можно восстановить методом [landing.landing.markundeletedblock](./landing-landing-mark-undeleted-block.md). Чтобы удалить блок сразу и без возможности восстановления, используйте метод [landing.landing.deleteblock](./landing-landing-delete-block.md).", "operationId": "landing_landing_markdeletedblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "mark": { "type": "boolean", "description": "| Признак пометки блока как удаленного. По умолчанию `true`." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "mark": { "type": "boolean", "description": "| Признак пометки блока как удаленного. По умолчанию `true`." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markundeletedblock": { "post": { "summary": "Снять отметку удаления с блока landing.landing.markundeletedblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.markundeletedblock` снимает с блока признак удаления.", "operationId": "landing_landing_markundeletedblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.move": { "post": { "summary": "Переместить страницу landing.landing.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.move` перемещает страницу в другой сайт или папку.", "operationId": "landing_landing_move", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-move.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно переместить." }, "toSiteId": { "type": "integer", "description": "| Идентификатор сайта назначения." }, "toFolderId": { "type": "integer", "description": "| Идентификатор папки назначения в целевом сайте." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно переместить." }, "toSiteId": { "type": "integer", "description": "| Идентификатор сайта назначения." }, "toFolderId": { "type": "integer", "description": "| Идентификатор папки назначения в целевом сайте." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.moveblock": { "post": { "summary": "Переместить блок на страницу landing.landing.moveblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.moveblock` переносит блок на указанную страницу и возвращает идентификатор перемещенного блока. Блок можно перенести как в пределах одной страницы, так и на другую страницу.", "operationId": "landing_landing_moveblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-move-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, на которую нужно перенести блок." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "params": { "type": "object", "description": "| Дополнительные параметры переноса (подробное описание) ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока на странице `lid`, после которого нужно разместить перемещаемый блок." }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, метод вернет объект с признаком успеха и данными перемещенного блока (подробное описание). При любом другом значении метод вернет только идентификатор перемещенного блока ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, на которую нужно перенести блок." }, "block": { "type": "integer", "description": "| Идентификатор блока." }, "params": { "type": "object", "description": "| Дополнительные параметры переноса (подробное описание) ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор блока на странице `lid`, после которого нужно разместить перемещаемый блок." }, "RETURN_CONTENT": { "type": "string", "description": "| Если передать `Y`, метод вернет объект с признаком успеха и данными перемещенного блока (подробное описание). При любом другом значении метод вернет только идентификатор перемещенного блока ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.publication": { "post": { "summary": "Опубликовать страницу landing.landing.publication", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.publication` публикует страницу и делает ее активной.", "operationId": "landing_landing_publication", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-publication.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.removeEntities": { "post": { "summary": "Удалить блоки и очистить файловые привязки изображений страницы landing.landing.removeEntities", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.removeEntities` удаляет со страницы указанные блоки и связанные с ними изображения. Также с его помощью можно очистить файловые привязки у отдельных изображений без удаления самих блоков.", "operationId": "landing_landing_removeEntities", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-remove-entities.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "data": { "type": "object", "description": "| Набор объектов для удаления (подробное описание)." }, "blocks": { "type": "string", "description": "| Идентификаторы блоков страницы, которые нужно удалить полностью." }, "images": { "type": "string", "description": "| Пары идентификаторов блока и изображения для удаления файловой привязки. Содержимое блока не изменяется — используйте, когда изображение уже убрано из блока и нужно очистить оставшуюся служебную запись. (подробное описание)." }, "block": { "type": "integer", "description": "| Идентификатор блока, с которым связана файловая привязка изображения ||" }, "image": { "type": "integer", "description": "| Внутренний идентификатор файловой привязки изображения (`FILE_ID`), связанной с блоком `block`." } }, "required": [ "lid", "data", "block", "image" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "data": { "type": "object", "description": "| Набор объектов для удаления (подробное описание)." }, "blocks": { "type": "string", "description": "| Идентификаторы блоков страницы, которые нужно удалить полностью." }, "images": { "type": "string", "description": "| Пары идентификаторов блока и изображения для удаления файловой привязки. Содержимое блока не изменяется — используйте, когда изображение уже убрано из блока и нужно очистить оставшуюся служебную запись. (подробное описание)." }, "block": { "type": "integer", "description": "| Идентификатор блока, с которым связана файловая привязка изображения ||" }, "image": { "type": "integer", "description": "| Внутренний идентификатор файловой привязки изображения (`FILE_ID`), связанной с блоком `block`." } }, "required": [ "lid", "data", "block", "image" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.resolveIdByPublicUrl": { "post": { "summary": "Получить идентификатор страницы по публичному URL landing.landing.resolveIdByPublicUrl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.resolveIdByPublicUrl` возвращает идентификатор страницы по ее публичному URL в рамках указанного сайта.", "operationId": "landing_landing_resolveIdByPublicUrl", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "landingUrl": { "type": "string", "description": "| Относительный публичный URL страницы внутри сайта `siteId`, например `/catalog/sale/`." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в рамках которого нужно найти страницу." } }, "required": [ "landingUrl", "siteId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "landingUrl": { "type": "string", "description": "| Относительный публичный URL страницы внутри сайта `siteId`, например `/catalog/sale/`." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в рамках которого нужно найти страницу." } }, "required": [ "landingUrl", "siteId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.showblock": { "post": { "summary": "Показать блок на странице landing.landing.showblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.showblock` показывает на странице блок, который был скрыт.", "operationId": "landing_landing_showblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-show-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.unFavoriteBlock": { "post": { "summary": "Удалить из сохраненного списка блоков landing.landing.unFavoriteBlock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.unFavoriteBlock` удаляет сохраненную копию блока. Исходный блок на странице не изменяется. При удалении сохраненного блока также удаляются связанные с ним файлы, например пользовательское превью, загруженное для этого блока.", "operationId": "landing_landing_unFavoriteBlock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "blockId": { "type": "integer", "description": "| Идентификатор сохраненной копии блока." } }, "required": [ "blockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "blockId": { "type": "integer", "description": "| Идентификатор сохраненной копии блока." } }, "required": [ "blockId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.unpublic": { "post": { "summary": "Снять страницу с публикации landing.landing.unpublic", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.unpublic` снимает страницу с публикации.", "operationId": "landing_landing_unpublic", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-unpublic.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.upblock": { "post": { "summary": "Переместить блок выше landing.landing.upblock", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.upblock` поднимает блок на одну позицию вверх в черновике страницы. Если страница уже опубликована, для посетителей изменение станет видно после команды «Опубликовать изменения» в интерфейсе или после вызова метода [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_upblock", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/block-methods/landing-landing-up-block.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы." }, "block": { "type": "integer", "description": "| Идентификатор блока в версии страницы для редактирования." }, "preventHistory": { "type": "boolean", "description": "| Если `true`, метод не добавляет действие в историю изменений страницы. По умолчанию `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.update": { "post": { "summary": "Изменить страницу landing.landing.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.landing.update` обновляет параметры страницы.", "operationId": "landing_landing_update", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/methods/landing-landing-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно обновить." }, "fields": { "type": "object", "description": "| Набор полей страницы для обновления (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название страницы ||" }, "CODE": { "type": "string", "description": "| Символьный код страницы. Код не может содержать символ `/` и не должен быть в формате `<буквы, цифры или _>_<число>_<число>`, например `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Произвольное описание страницы ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор страницы ||" }, "SITE_ID": { "type": "integer", "description": "| Идентификатор сайта, к которому нужно привязать страницу. Если параметр не передан, используется текущий сайт страницы." }, "SITEMAP": { "type": "string", "description": "| Флаг включения страницы в карту сайта. Поддерживаются значения `Y` и `N`. Любое другое значение будет сохранено как `N` ||" }, "FOLDER": { "type": "string", "description": "| Признак папки. Поддерживаются значения `Y` и `N`. Любое другое значение будет сохранено как `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которую нужно поместить страницу. Папка должна находиться в текущем сайте страницы. Если передать `0`, страница будет перенесена в корень сайта." }, "TPL_ID": { "type": "integer", "description": "| Идентификатор шаблона представления страницы." }, "DELETED": { "type": "string", "description": "| Управляет состоянием страницы в корзине. При передаче этого поля страница становится неактивной." }, "DATE_PUBLIC": { "type": "string", "description": "| Дата и время публикации страницы." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля страницы. Доступные коды и значения описаны в статье Дополнительные поля страницы ||" } }, "required": [ "lid", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно обновить." }, "fields": { "type": "object", "description": "| Набор полей страницы для обновления (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название страницы ||" }, "CODE": { "type": "string", "description": "| Символьный код страницы. Код не может содержать символ `/` и не должен быть в формате `<буквы, цифры или _>_<число>_<число>`, например `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Произвольное описание страницы ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор страницы ||" }, "SITE_ID": { "type": "integer", "description": "| Идентификатор сайта, к которому нужно привязать страницу. Если параметр не передан, используется текущий сайт страницы." }, "SITEMAP": { "type": "string", "description": "| Флаг включения страницы в карту сайта. Поддерживаются значения `Y` и `N`. Любое другое значение будет сохранено как `N` ||" }, "FOLDER": { "type": "string", "description": "| Признак папки. Поддерживаются значения `Y` и `N`. Любое другое значение будет сохранено как `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Идентификатор папки, в которую нужно поместить страницу. Папка должна находиться в текущем сайте страницы. Если передать `0`, страница будет перенесена в корень сайта." }, "TPL_ID": { "type": "integer", "description": "| Идентификатор шаблона представления страницы." }, "DELETED": { "type": "string", "description": "| Управляет состоянием страницы в корзине. При передаче этого поля страница становится неактивной." }, "DATE_PUBLIC": { "type": "string", "description": "| Дата и время публикации страницы." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля страницы. Доступные коды и значения описаны в статье Дополнительные поля страницы ||" } }, "required": [ "lid", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.bind": { "post": { "summary": "Зарегистрировать место встраивания landing.repo.bind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.bind` регистрирует место встраивания текущего приложения в разделе Сайты.", "operationId": "landing_repo_bind", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/landing-repo-bind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TITLE": { "type": "string", "description": "| Название пункта приложения в интерфейсе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TITLE": { "type": "string", "description": "| Название пункта приложения в интерфейсе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.checkContent": { "post": { "summary": "Проверить контент на опасные подстроки landing.repo.checkContent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.checkContent` проверяет контент через санитайзер.", "operationId": "landing_repo_checkContent", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/user-blocks/landing-repo-check-content.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "splitter": { "type": "string", "description": "| Разделитель, которым помечаются опасные фрагменты в `content`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "splitter": { "type": "string", "description": "| Разделитель, которым помечаются опасные фрагменты в `content`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.getList": { "post": { "summary": "Получить список пользовательских блоков landing.repo.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.getList` получает список пользовательских блоков.", "operationId": "landing_repo_getList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/user-blocks/landing-repo-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "string", "description": "| Массив формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "group": { "type": "array", "items": {}, "description": "| Массив полей для группировки результата." }, "limit": { "type": "integer", "description": "| Лимит записей ||" }, "offset": { "type": "integer", "description": "| Смещение записей ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект формата:" }, "select": { "type": "string", "description": "| Массив формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "order": { "type": "object", "description": "| Объект формата:" }, "group": { "type": "array", "items": {}, "description": "| Массив полей для группировки результата." }, "limit": { "type": "integer", "description": "| Лимит записей ||" }, "offset": { "type": "integer", "description": "| Смещение записей ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.register": { "post": { "summary": "Добавить пользовательский блок в репозиторий landing.repo.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.register` добавляет новый пользовательский блок в репозиторий.", "operationId": "landing_repo_register", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/user-blocks/landing-repo-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "manifest": { "type": "object", "description": "| Манифест блока." }, "DESCRIPTION": { "type": "string", "description": "| Описание блока ||" }, "ACTIVE": { "type": "string", "description": "| Активность блока (`Y`/`N`) ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка блока к шаблону сайта ||" }, "RESET": { "type": "string", "description": "| Если передать `Y`, метод регистрирует обновление добавленных на страницы блоков с кодом `repo_` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "manifest": { "type": "object", "description": "| Манифест блока." }, "DESCRIPTION": { "type": "string", "description": "| Описание блока ||" }, "ACTIVE": { "type": "string", "description": "| Активность блока (`Y`/`N`) ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка блока к шаблону сайта ||" }, "RESET": { "type": "string", "description": "| Если передать `Y`, метод регистрирует обновление добавленных на страницы блоков с кодом `repo_` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.unbind": { "post": { "summary": "Удалить место встраивания landing.repo.unbind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.unbind` удаляет место встраивания, зарегистрированное текущим приложением в разделе `landing`.", "operationId": "landing_repo_unbind", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/landing-repo-unbind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "handler": { "type": "string", "description": "| Полный адрес обработчика места встраивания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "handler": { "type": "string", "description": "| Полный адрес обработчика места встраивания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.unregister": { "post": { "summary": "Удалить пользовательский блок landing.repo.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repo.unregister` удаляет пользовательский блок по его коду.", "operationId": "landing_repo_unregister", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/user-blocks/landing-repo-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.debug": { "post": { "summary": "Включить или выключить режим отладки landing.repowidget.debug", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repowidget.debug` включает или выключает режим отладки для всех виджетов текущего приложения.", "operationId": "landing_repowidget_debug", "tags": [ "Вайб" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vibe/landing-repowidget-debug.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enable": { "type": "boolean", "description": "| Режим отладки. Возможные значения:" } }, "required": [ "enable" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "enable": { "type": "boolean", "description": "| Режим отладки. Возможные значения:" } }, "required": [ "enable" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.getlist": { "post": { "summary": "Получить список виджетов landing.repowidget.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repowidget.getlist` возвращает список виджетов Вайба текущего приложения, отобранных по фильтру. Если вызвать метод вебхуком, он вернет виджеты, зарегистрированные без приложения.", "operationId": "landing_repowidget_getlist", "tags": [ "Вайб" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vibe/landing-repowidget-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Параметры выборки (подробное описание)." }, "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "group": { "type": "array", "items": {}, "description": "| Массив для группировки виджетов. Группировать можно по полям виджета ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "limit": { "type": "integer", "description": "| Максимальное количество записей в выборке. Ограничение применяется ко всем блокам приложения в репозитории, включая блоки, добавленные методом landing.repo.register. Виджеты Вайба отбираются уже после этого, поэтому при `limit: 10` метод может вернуть меньше 10 виджетов ||" }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала выборки. Используется вместе с `limit` ||" }, "ID": { "type": "integer", "description": "| Идентификатор виджета ||" }, "XML_ID": { "type": "string", "description": "| Уникальный код записи ||" }, "APP_CODE": { "type": "string", "description": "| Код текущего приложения ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность виджета. Принимает значения:" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета ||" }, "SECTIONS": { "type": "string", "description": "| Код раздела, в который будет добавлен виджет ||" }, "PREVIEW": { "type": "string", "description": "| URL картинки-обложки виджета для слайдера выбора виджетов ||" }, "CONTENT": { "type": "string", "description": "| Верстка виджета с использованием конструкций Vue ||" }, "MANIFEST": { "type": "object", "description": "| Манифест виджета. Содержит:" }, "CREATED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, создавшего запись ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, изменившего запись ||" }, "DATE_CREATE": { "type": "string", "description": "| Дата создания. В ответе — строка в формате даты и времени Битрикс24, например `10.10.2024 15:55:30` ||" }, "DATE_MODIFY": { "type": "string", "description": "| Дата изменения. Формат как у `DATE_CREATE` ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24! ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Параметры выборки (подробное описание)." }, "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "group": { "type": "array", "items": {}, "description": "| Массив для группировки виджетов. Группировать можно по полям виджета ||" }, "order": { "type": "object", "description": "| Объект для сортировки выбранных записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "limit": { "type": "integer", "description": "| Максимальное количество записей в выборке. Ограничение применяется ко всем блокам приложения в репозитории, включая блоки, добавленные методом landing.repo.register. Виджеты Вайба отбираются уже после этого, поэтому при `limit: 10` метод может вернуть меньше 10 виджетов ||" }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала выборки. Используется вместе с `limit` ||" }, "ID": { "type": "integer", "description": "| Идентификатор виджета ||" }, "XML_ID": { "type": "string", "description": "| Уникальный код записи ||" }, "APP_CODE": { "type": "string", "description": "| Код текущего приложения ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность виджета. Принимает значения:" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета ||" }, "SECTIONS": { "type": "string", "description": "| Код раздела, в который будет добавлен виджет ||" }, "PREVIEW": { "type": "string", "description": "| URL картинки-обложки виджета для слайдера выбора виджетов ||" }, "CONTENT": { "type": "string", "description": "| Верстка виджета с использованием конструкций Vue ||" }, "MANIFEST": { "type": "object", "description": "| Манифест виджета. Содержит:" }, "CREATED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, создавшего запись ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, изменившего запись ||" }, "DATE_CREATE": { "type": "string", "description": "| Дата создания. В ответе — строка в формате даты и времени Битрикс24, например `10.10.2024 15:55:30` ||" }, "DATE_MODIFY": { "type": "string", "description": "| Дата изменения. Формат как у `DATE_CREATE` ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24! ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.register": { "post": { "summary": "Добавить виджет для Вайба landing.repowidget.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repowidget.register` добавляет виджет для Вайба.", "operationId": "landing_repowidget_register", "tags": [ "Вайб" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vibe/landing-repowidget-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код виджета, уникальный в пределах приложения. Виджеты разных приложений с одинаковым кодом не конфликтуют ||" }, "fields": { "type": "object", "description": "| Значения полей для создания виджета (подробное описание) ||" }, "PREVIEW": { "type": "string", "description": "| URL картинки-обложки виджета для слайдера выбора виджетов ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета ||" }, "CONTENT": { "type": "string", "description": "| Верстка виджета с использованием конструкций Vue ||" }, "SECTIONS": { "type": "string", "description": "| Код раздела, в который будет добавлен виджет. Список доступных разделов:" }, "WIDGET_PARAMS": { "type": "object", "description": "| Параметры для шаблонизатора Vue ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность виджета. Принимает значения:" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24! ||" }, "rootNode": { "type": "string", "description": "| Селектор корневого элемента в верстке `CONTENT`, который будет превращен в компонент Vue. Вся верстка должна быть внутри корневого элемента. Если селектор не найдет элемент в `CONTENT`, виджет не отрисуется ||" }, "lang": { "type": "object", "description": "| Языковые фразы для конструкций `{{$Bitrix.Loc.getMessage('W_EMPTY')}}` в формате `{\"код языка\": {\"КОД_ФРАЗЫ\": \"текст\"}}`, например `{\"ru\": {\"W_EMPTY\": \"Нет данных\"}, \"en\": {\"W_EMPTY\": \"No data\"}}`." }, "handler": { "type": "string", "description": "| Адрес внешнего обработчика, к которому будут выполняться запросы." }, "style": { "type": "string", "description": "| Адрес стилей для виджета. Стили также могут быть заданы инлайново в разметке через привязку `:style=\"{borderBottom: '1px solid red'}\"` ||" }, "demoData": { "type": "object", "description": "| Демо-данные для виджета. Они отображаются в слайдере предварительного просмотра шаблона Вайба в Маркете, поэтому их структура должна совпадать с ответом обработчика `handler`." } }, "required": [ "code", "fields", "PREVIEW", "CONTENT", "SECTIONS", "WIDGET_PARAMS", "rootNode", "handler", "demoData" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Код виджета, уникальный в пределах приложения. Виджеты разных приложений с одинаковым кодом не конфликтуют ||" }, "fields": { "type": "object", "description": "| Значения полей для создания виджета (подробное описание) ||" }, "PREVIEW": { "type": "string", "description": "| URL картинки-обложки виджета для слайдера выбора виджетов ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета ||" }, "CONTENT": { "type": "string", "description": "| Верстка виджета с использованием конструкций Vue ||" }, "SECTIONS": { "type": "string", "description": "| Код раздела, в который будет добавлен виджет. Список доступных разделов:" }, "WIDGET_PARAMS": { "type": "object", "description": "| Параметры для шаблонизатора Vue ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Активность виджета. Принимает значения:" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24! ||" }, "rootNode": { "type": "string", "description": "| Селектор корневого элемента в верстке `CONTENT`, который будет превращен в компонент Vue. Вся верстка должна быть внутри корневого элемента. Если селектор не найдет элемент в `CONTENT`, виджет не отрисуется ||" }, "lang": { "type": "object", "description": "| Языковые фразы для конструкций `{{$Bitrix.Loc.getMessage('W_EMPTY')}}` в формате `{\"код языка\": {\"КОД_ФРАЗЫ\": \"текст\"}}`, например `{\"ru\": {\"W_EMPTY\": \"Нет данных\"}, \"en\": {\"W_EMPTY\": \"No data\"}}`." }, "handler": { "type": "string", "description": "| Адрес внешнего обработчика, к которому будут выполняться запросы." }, "style": { "type": "string", "description": "| Адрес стилей для виджета. Стили также могут быть заданы инлайново в разметке через привязку `:style=\"{borderBottom: '1px solid red'}\"` ||" }, "demoData": { "type": "object", "description": "| Демо-данные для виджета. Они отображаются в слайдере предварительного просмотра шаблона Вайба в Маркете, поэтому их структура должна совпадать с ответом обработчика `handler`." } }, "required": [ "code", "fields", "PREVIEW", "CONTENT", "SECTIONS", "WIDGET_PARAMS", "rootNode", "handler", "demoData" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.unregister": { "post": { "summary": "Удалить виджет для Вайба landing.repowidget.unregister", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.repowidget.unregister` удаляет виджет для Вайба по его коду. Вместе с виджетом удаляются все его экземпляры, размещенные на страницах Вайба.", "operationId": "landing_repowidget_unregister", "tags": [ "Вайб" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vibe/landing-repowidget-unregister.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код удаляемого виджета — который передавали в `code` при регистрации методом landing.repowidget.register." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Уникальный код удаляемого виджета — который передавали в `code` при регистрации методом landing.repowidget.register." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.enable": { "post": { "summary": "Включить или выключить ролевую модель прав landing.role.enable", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.enable` включает или выключает ролевую модель прав для раздела «Сайты и магазины».", "operationId": "landing_role_enable", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/landing-role-enable.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, из которого выполняется вызов. Параметр не связан с REST-скоупом `landing` в названии метода." }, "mode": { "type": "boolean", "description": "\\| `integer` | Режим модели прав. Проверить текущую модель можно методом landing.role.isEnabled." } }, "required": [ "mode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, из которого выполняется вызов. Параметр не связан с REST-скоупом `landing` в названии метода." }, "mode": { "type": "boolean", "description": "\\| `integer` | Режим модели прав. Проверить текущую модель можно методом landing.role.isEnabled." } }, "required": [ "mode" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.getList": { "post": { "summary": "Получить список ролей landing.role.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.getList` получает список ролей доступа для выбранного типа сайтов.", "operationId": "landing_role_getList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/role-model/landing-role-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Тип сайтов, для которого нужно получить роли. Параметр не связан с REST-скоупом `landing` в названии метода." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Тип сайтов, для которого нужно получить роли. Параметр не связан с REST-скоупом `landing` в названии метода." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.getRights": { "post": { "summary": "Получить права роли landing.role.getRights", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.getRights` возвращает права указанной роли по каждому сайту, для которого они настроены.", "operationId": "landing_role_getRights", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/role-model/landing-role-get-rights.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли. Получить идентификатор можно с помощью метода landing.role.getList ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли. Получить идентификатор можно с помощью метода landing.role.getList ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.isEnabled": { "post": { "summary": "Проверить, включена ли ролевая модель прав landing.role.isEnabled", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.isEnabled` проверяет, включена ли ролевая модель прав для раздела «Сайты и магазины».", "operationId": "landing_role_isEnabled", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/landing-role-is-enabled.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.setAccessCodes": { "post": { "summary": "Установить коды доступа для роли landing.role.setAccessCodes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.setAccessCodes` задает, кому назначена роль: пользователям, группам или отделам. После вызова метод заново применяет уже сохраненные права этой роли для сайтов.", "operationId": "landing_role_setAccessCodes", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/role-model/landing-role-set-access-codes.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли. Получить идентификатор можно с помощью метода landing.role.getList ||" }, "codes": { "type": "string", "description": "| Итоговый список кодов доступа для роли." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли. Получить идентификатор можно с помощью метода landing.role.getList ||" }, "codes": { "type": "string", "description": "| Итоговый список кодов доступа для роли." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.setRights": { "post": { "summary": "Установить права роли для списка сайтов landing.role.setRights", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.role.setRights` устанавливает права роли по сайтам. Для каждого сайта можно задать отдельные права, а для остальных — общие права по умолчанию. Новый набор прав полностью заменяет предыдущий.", "operationId": "landing_role_setRights", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/role-model/landing-role-set-rights.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли, для которой нужно обновить права." }, "rights": { "type": "object", "description": "\\| `array` | Объект формата:" }, "additional": { "type": "string", "description": "| Дополнительные возможности роли." } }, "required": [ "id", "rights" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор роли, для которой нужно обновить права." }, "rights": { "type": "object", "description": "\\| `array` | Объект формата:" }, "additional": { "type": "string", "description": "| Дополнительные возможности роли." } }, "required": [ "id", "rights" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.add": { "post": { "summary": "Добавить сайт landing.site.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.add` создает новый сайт и возвращает идентификатор созданного сайта.", "operationId": "landing_site_add", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "fields": { "type": "object", "description": "| Набор полей нового сайта (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сайта, длина до `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код сайта. Если передать пустую строку, код сгенерируется из поля `TITLE`. Для кода, который состоит только из цифр, автоматически добавится префикс `site`." }, "TYPE": { "type": "string", "description": "| Тип сайта. По умолчанию `PAGE`. Поддерживаются `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Домен сайта. Значение зависит от платформы." }, "DESCRIPTION": { "type": "string", "description": "| Описание сайта, до `255` символов ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор, до `255` символов ||" }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля сайта, сохраняются отдельно после создания ||" }, "fields.TYPE": { "type": "string", "description": "| scope в запросе | Когда использовать ||" } }, "required": [ "fields", "TITLE", "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "fields": { "type": "object", "description": "| Набор полей нового сайта (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сайта, длина до `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код сайта. Если передать пустую строку, код сгенерируется из поля `TITLE`. Для кода, который состоит только из цифр, автоматически добавится префикс `site`." }, "TYPE": { "type": "string", "description": "| Тип сайта. По умолчанию `PAGE`. Поддерживаются `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Домен сайта. Значение зависит от платформы." }, "DESCRIPTION": { "type": "string", "description": "| Описание сайта, до `255` символов ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор, до `255` символов ||" }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Дополнительные поля сайта, сохраняются отдельно после создания ||" }, "fields.TYPE": { "type": "string", "description": "| scope в запросе | Когда использовать ||" } }, "required": [ "fields", "TITLE", "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.addFolder": { "post": { "summary": "Добавить папку в сайт landing.site.addFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.addFolder` создает папку в указанном сайте и возвращает идентификатор созданной папки.", "operationId": "landing_site_addFolder", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-add-folder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в котором нужно создать папку." }, "fields": { "type": "object", "description": "| Набор полей создаваемой папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название папки, максимальная длина `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код папки для URL, максимальная длина `255` символов. Если не передан или пустой, код создается из `TITLE` транслитерацией." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительской папки. Если значение `0`, `null` или пустое, папка создается в корне сайта ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности папки `Y/N`, по умолчанию `N` ||" } }, "required": [ "siteId", "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, в котором нужно создать папку." }, "fields": { "type": "object", "description": "| Набор полей создаваемой папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название папки, максимальная длина `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код папки для URL, максимальная длина `255` символов. Если не передан или пустой, код создается из `TITLE` транслитерацией." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительской папки. Если значение `0`, `null` или пустое, папка создается в корне сайта ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности папки `Y/N`, по умолчанию `N` ||" } }, "required": [ "siteId", "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.bindingToGroup": { "post": { "summary": "Привязать Базу знаний к группе Социальной сети landing.site.bindingToGroup", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.bindingToGroup` привязывает Базу знаний к группе Социальной сети. После привязки Базе знаний присваивается тип `GROUP`, и [landing.site.getList](../../site/landing-site-get-list.md#type-scope) с `scope: \"KNOWLEDGE\"` ее больше не возвращает.", "operationId": "landing_site_bindingToGroup", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.bindingToMenu": { "post": { "summary": "Привязать Базу знаний к меню landing.site.bindingToMenu", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.bindingToMenu` привязывает Базу знаний к указанному меню.", "operationId": "landing_site_bindingToMenu", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.delete": { "post": { "summary": "Удалить сайт landing.site.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.delete` удаляет только пустой сайт без страниц.", "operationId": "landing_site_delete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.fullExport": { "post": { "summary": "Экспортировать сайт landing.site.fullExport", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.fullExport` экспортирует сайт и его страницы в массив для последующего импорта, например через [landing.demos.register](../demos/landing-demos-register.md).", "operationId": "landing_site_fullExport", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-full-export.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "params": { "type": "object", "description": "| Дополнительные параметры экспорта (подробное описание) ||" }, "edit_mode": { "type": "string", "description": "| Режим экспорта хуков. При значении `Y` включается режим редактирования. По умолчанию используется обычный режим ||" }, "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` или `landing_cloud` в названии метода." }, "hooks_disable": { "type": "string", "description": "| Коды дополнительных полей, которые нужно исключить из `ADDITIONAL_FIELDS` на уровне сайта и страниц." }, "code": { "type": "string", "description": "| Код экспортируемого сайта. Если не передан, используется текущий код сайта без крайних `/`." }, "description": { "type": "string", "description": "| Описание сайта в экспорте. Если не передано, используется текущее описание сайта ||" }, "preview": { "type": "string", "description": "| URL основной превью-картинки. По умолчанию пустая строка ||" }, "preview2x": { "type": "string", "description": "| URL увеличенной превью-картинки. По умолчанию пустая строка ||" }, "preview3x": { "type": "string", "description": "| URL retina-превью. По умолчанию пустая строка ||" }, "preview_url": { "type": "string", "description": "| URL предпросмотра шаблона. По умолчанию пустая строка ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "params": { "type": "object", "description": "| Дополнительные параметры экспорта (подробное описание) ||" }, "edit_mode": { "type": "string", "description": "| Режим экспорта хуков. При значении `Y` включается режим редактирования. По умолчанию используется обычный режим ||" }, "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` или `landing_cloud` в названии метода." }, "hooks_disable": { "type": "string", "description": "| Коды дополнительных полей, которые нужно исключить из `ADDITIONAL_FIELDS` на уровне сайта и страниц." }, "code": { "type": "string", "description": "| Код экспортируемого сайта. Если не передан, используется текущий код сайта без крайних `/`." }, "description": { "type": "string", "description": "| Описание сайта в экспорте. Если не передано, используется текущее описание сайта ||" }, "preview": { "type": "string", "description": "| URL основной превью-картинки. По умолчанию пустая строка ||" }, "preview2x": { "type": "string", "description": "| URL увеличенной превью-картинки. По умолчанию пустая строка ||" }, "preview3x": { "type": "string", "description": "| URL retina-превью. По умолчанию пустая строка ||" }, "preview_url": { "type": "string", "description": "| URL предпросмотра шаблона. По умолчанию пустая строка ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getFolders": { "post": { "summary": "Получить папки сайта landing.site.getFolders", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getFolders` возвращает список папок сайта.", "operationId": "landing_site_getFolders", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-get-folders.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, для которого запрашиваются папки." }, "filter": { "type": "object", "description": "| Фильтр по полям папки (подробное описание) ||" }, "ID": { "type": "integer", "description": "| Идентификатор папки ||" }, "PARENT_ID": { "type": "integer", "description": "\\| `null` | Идентификатор родительской папки. Если передать `0`, `null`, `false` или пустую строку, значение будет приведено к `null`, это выборка папок верхнего уровня ||" }, "INDEX_ID": { "type": "integer", "description": "| Идентификатор индексной страницы папки ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности `Y/N` ||" }, "DELETED": { "type": "string", "description": "| Флаг удаления `Y/N` ||" }, "TITLE": { "type": "string", "description": "| Название папки ||" }, "CODE": { "type": "string", "description": "| Символьный код папки ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, создавшего папку ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, изменившего папку ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата и время создания папки ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата и время изменения папки ||" } }, "required": [ "siteId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, для которого запрашиваются папки." }, "filter": { "type": "object", "description": "| Фильтр по полям папки (подробное описание) ||" }, "ID": { "type": "integer", "description": "| Идентификатор папки ||" }, "PARENT_ID": { "type": "integer", "description": "\\| `null` | Идентификатор родительской папки. Если передать `0`, `null`, `false` или пустую строку, значение будет приведено к `null`, это выборка папок верхнего уровня ||" }, "INDEX_ID": { "type": "integer", "description": "| Идентификатор индексной страницы папки ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности `Y/N` ||" }, "DELETED": { "type": "string", "description": "| Флаг удаления `Y/N` ||" }, "TITLE": { "type": "string", "description": "| Название папки ||" }, "CODE": { "type": "string", "description": "| Символьный код папки ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, создавшего папку ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Идентификатор пользователя, изменившего папку ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата и время создания папки ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Дата и время изменения папки ||" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getGroupBindings": { "post": { "summary": "Получить привязки к группам landing.site.getGroupBindings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getGroupBindings` возвращает привязки Баз знаний к группам. Используйте его, чтобы проверить результат [landing.site.bindingToGroup](./landing-site-binding-to-group.md) и получить `id` Базы знаний и идентификатор группы для [landing.site.unbindingFromGroup](./landing-site-unbinding-from-group.md).", "operationId": "landing_site_getGroupBindings", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "\\| `null` | Идентификатор группы для фильтрации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "\\| `null` | Идентификатор группы для фильтрации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getList": { "post": { "summary": "Получить список сайтов landing.site.getList", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getList` получает список сайтов по параметрам выборки.", "operationId": "landing_site_getList", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "params": { "type": "object", "description": "| Параметры выборки сайтов (подробное описание) ||" }, "select": { "type": "string", "description": "| Список полей для выборки из базовых полей сайта. Если параметр не передан или передан не массив, используется `[\"*\"]`. Метод всегда добавляет в выборку `ID` и `TYPE`." }, "filter": { "type": "object", "description": "| Фильтр по полям из базовых полей сайта. Если параметр не передан или передан не массив, используется пустой фильтр `{}`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC DESC\"}`. Если параметр не передан, специальная сортировка не применяется ||" }, "group": { "type": "array", "items": {}, "description": "| Группировка в формате ORM. Если передан не массив, параметр приводится к пустому массиву. При фильтрации по правам доступа в группировку добавляется `ID` ||" }, "limit": { "type": "integer", "description": "| Ограничение количества строк выборки на уровне ORM. По умолчанию не задано ||" }, "offset": { "type": "integer", "description": "| Смещение выборки на уровне ORM. Если параметр не передан, применяется поведение ORM по умолчанию ||" }, "params.filter.TYPE": { "type": "string", "description": "| scope в запросе | Когда использовать ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "params": { "type": "object", "description": "| Параметры выборки сайтов (подробное описание) ||" }, "select": { "type": "string", "description": "| Список полей для выборки из базовых полей сайта. Если параметр не передан или передан не массив, используется `[\"*\"]`. Метод всегда добавляет в выборку `ID` и `TYPE`." }, "filter": { "type": "object", "description": "| Фильтр по полям из базовых полей сайта. Если параметр не передан или передан не массив, используется пустой фильтр `{}`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC DESC\"}`. Если параметр не передан, специальная сортировка не применяется ||" }, "group": { "type": "array", "items": {}, "description": "| Группировка в формате ORM. Если передан не массив, параметр приводится к пустому массиву. При фильтрации по правам доступа в группировку добавляется `ID` ||" }, "limit": { "type": "integer", "description": "| Ограничение количества строк выборки на уровне ORM. По умолчанию не задано ||" }, "offset": { "type": "integer", "description": "| Смещение выборки на уровне ORM. Если параметр не передан, применяется поведение ORM по умолчанию ||" }, "params.filter.TYPE": { "type": "string", "description": "| scope в запросе | Когда использовать ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getMenuBindings": { "post": { "summary": "Получить привязки к меню landing.site.getMenuBindings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getMenuBindings` возвращает привязки Баз знаний к меню. Используйте его, чтобы проверить результат [landing.site.bindingToMenu](./landing-site-binding-to-menu.md) и получить `id` Базы знаний и код меню для [landing.site.unbindingFromMenu](./landing-site-unbinding-from-menu.md).", "operationId": "landing_site_getMenuBindings", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "menuCode": { "type": "string", "description": "\\| `null` | Код меню для фильтрации." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "menuCode": { "type": "string", "description": "\\| `null` | Код меню для фильтрации." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getPreview": { "post": { "summary": "Получить URL превью сайта landing.site.getPreview", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getPreview` возвращает URL превью индексной страницы сайта.", "operationId": "landing_site_getPreview", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-get-preview.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getPublicUrl": { "post": { "summary": "Получить публичный URL сайта landing.site.getPublicUrl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getPublicUrl` возвращает полный публичный URL сайта или нескольких сайтов.", "operationId": "landing_site_getPublicUrl", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-get-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "\\| `array` | Идентификатор сайта или массив идентификаторов сайтов. Если передан один идентификатор, в `result` вернется строка URL." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "\\| `array` | Идентификатор сайта или массив идентификаторов сайтов. Если передан один идентификатор, в `result` вернется строка URL." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getRights": { "post": { "summary": "Получить права доступа к сайту landing.site.getRights", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getRights` получает список прав текущего пользователя для указанного сайта.", "operationId": "landing_site_getRights", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/extended-model/landing-site-get-rights.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getadditionalfields": { "post": { "summary": "Получить дополнительные поля сайта landing.site.getadditionalfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.getadditionalfields` получает дополнительные поля сайта.", "operationId": "landing_site_getadditionalfields", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-get-additional-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markDelete": { "post": { "summary": "Пометить сайт как удаленный landing.site.markDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.markDelete` помечает сайт как удаленный, переносит его в корзину и снимает с публикации.", "operationId": "landing_site_markDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-mark-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." }, "mark": { "type": "boolean", "description": "| Признак пометки сайта как удаленного. По умолчанию `true`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." }, "mark": { "type": "boolean", "description": "| Признак пометки сайта как удаленного. По умолчанию `true`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markFolderDelete": { "post": { "summary": "Пометить папку как удаленную landing.site.markFolderDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.markFolderDelete` помечает папку как удаленную и переносит ее в корзину. При успешном вызове метод также помечает как удаленные страницы в этой папке и во вложенных папках. Такие страницы снимаются с публикации.", "operationId": "landing_site_markFolderDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-mark-folder-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор папки." }, "mark": { "type": "boolean", "description": "| Признак пометки папки как удаленной. По умолчанию `true`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор папки." }, "mark": { "type": "boolean", "description": "| Признак пометки папки как удаленной. По умолчанию `true`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markFolderUnDelete": { "post": { "summary": "Восстановить папку из корзины landing.site.markFolderUnDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.markFolderUnDelete` восстанавливает папку из корзины и снимает признак удаления у этой папки и страниц в ней.", "operationId": "landing_site_markFolderUnDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-mark-folder-undelete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markUnDelete": { "post": { "summary": "Восстановить сайт из корзины landing.site.markUnDelete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.markUnDelete` восстанавливает сайт из корзины и снимает признак удаления.", "operationId": "landing_site_markUnDelete", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-mark-undelete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.publication": { "post": { "summary": "Опубликовать сайт landing.site.publication", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.publication` публикует сайт и его страницы.", "operationId": "landing_site_publication", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-publication.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.publicationFolder": { "post": { "summary": "Опубликовать папку сайта landing.site.publicationFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.publicationFolder` публикует папку сайта и ее цепочку родительских папок.", "operationId": "landing_site_publicationFolder", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-publication-folder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "folderId": { "type": "integer", "description": "| Идентификатор папки." }, "mark": { "type": "boolean", "description": "| Флаг публикации. `true` (по умолчанию) публикует папку, `false` снимает папку с публикации." } }, "required": [ "folderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "folderId": { "type": "integer", "description": "| Идентификатор папки." }, "mark": { "type": "boolean", "description": "| Флаг публикации. `true` (по умолчанию) публикует папку, `false` снимает папку с публикации." } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.setRights": { "post": { "summary": "Установить права доступа для сайта landing.site.setRights", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.setRights` устанавливает права доступа в расширенной модели прав для указанного сайта.", "operationId": "landing_site_setRights", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/rights/extended-model/landing-site-set-rights.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор сайта." }, "rights": { "type": "object", "description": "\\| `array` | Объект формата:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Идентификатор сайта." }, "rights": { "type": "object", "description": "\\| `array` | Объект формата:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unPublicFolder": { "post": { "summary": "Снять папку сайта с публикации landing.site.unPublicFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.unPublicFolder` снимает с публикации папку сайта и ее цепочку родительских папок.", "operationId": "landing_site_unPublicFolder", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-unpublic-folder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "folderId": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "folderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "folderId": { "type": "integer", "description": "| Идентификатор папки." } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unbindingFromGroup": { "post": { "summary": "Отвязать Базу знаний от группы Социальной сети landing.site.unbindingFromGroup", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.unbindingFromGroup` отвязывает Базу знаний от группы Социальной сети. После отвязки Базе знаний возвращается тип `KNOWLEDGE`.", "operationId": "landing_site_unbindingFromGroup", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unbindingFromMenu": { "post": { "summary": "Отвязать Базу знаний от меню landing.site.unbindingFromMenu", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.unbindingFromMenu` отвязывает Базу знаний от указанного меню. Привязки этой Базы знаний к другим меню и сама База знаний сохраняются.", "operationId": "landing_site_unbindingFromMenu", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unpublic": { "post": { "summary": "Снять сайт с публикации landing.site.unpublic", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.unpublic` снимает сайт и его страницы с публикации и деактивирует сайт.", "operationId": "landing_site_unpublic", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-unpublic.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.update": { "post": { "summary": "Изменить сайт landing.site.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.update` обновляет параметры сайта.", "operationId": "landing_site_update", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." }, "fields": { "type": "object", "description": "| Набор полей для обновления сайта (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сайта, длина до `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код сайта. При передаче пустой строки код генерируется из `TITLE` или из строки `site`." }, "TYPE": { "type": "string", "description": "| Тип сайта. Поддерживаются `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Домен сайта. Обычно передают доменное имя. Для сайтов типов `PAGE`, `STORE`, `SMN`, если параметр не передан или передана пустая строка, значение параметра игнорируется. Для `GROUP`, `KNOWLEDGE` и `MAINPAGE` параметр обычно не передают." }, "DESCRIPTION": { "type": "string", "description": "| Описание сайта, длина до `255` символов ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор сайта ||" }, "LANDING_ID_INDEX": { "type": "integer", "description": "| Идентификатор страницы сайта, которая будет главной ||" }, "LANDING_ID_404": { "type": "integer", "description": "| Идентификатор страницы ошибки 404 ||" }, "LANDING_ID_503": { "type": "integer", "description": "| Идентификатор страницы ошибки 503 ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор сайта." }, "fields": { "type": "object", "description": "| Набор полей для обновления сайта (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название сайта, длина до `255` символов ||" }, "CODE": { "type": "string", "description": "| Символьный код сайта. При передаче пустой строки код генерируется из `TITLE` или из строки `site`." }, "TYPE": { "type": "string", "description": "| Тип сайта. Поддерживаются `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Домен сайта. Обычно передают доменное имя. Для сайтов типов `PAGE`, `STORE`, `SMN`, если параметр не передан или передана пустая строка, значение параметра игнорируется. Для `GROUP`, `KNOWLEDGE` и `MAINPAGE` параметр обычно не передают." }, "DESCRIPTION": { "type": "string", "description": "| Описание сайта, длина до `255` символов ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор сайта ||" }, "LANDING_ID_INDEX": { "type": "integer", "description": "| Идентификатор страницы сайта, которая будет главной ||" }, "LANDING_ID_404": { "type": "integer", "description": "| Идентификатор страницы ошибки 404 ||" }, "LANDING_ID_503": { "type": "integer", "description": "| Идентификатор страницы ошибки 503 ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.updateFolder": { "post": { "summary": "Изменить папку в сайте landing.site.updateFolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.site.updateFolder` обновляет параметры папки сайта.", "operationId": "landing_site_updateFolder", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/site/landing-site-update-folder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, к которому относится папка." }, "folderId": { "type": "integer", "description": "| Идентификатор папки, которую нужно обновить." }, "fields": { "type": "object", "description": "| Набор полей для обновления папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название папки ||" }, "CODE": { "type": "string", "description": "| Символьный код папки для URL. Код не может содержать символ `/`." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительской папки." }, "INDEX_ID": { "type": "integer", "description": "| Идентификатор индексной страницы папки ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности папки `Y/N` ||" } }, "required": [ "siteId", "folderId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "siteId": { "type": "integer", "description": "| Идентификатор сайта, к которому относится папка." }, "folderId": { "type": "integer", "description": "| Идентификатор папки, которую нужно обновить." }, "fields": { "type": "object", "description": "| Набор полей для обновления папки (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Название папки ||" }, "CODE": { "type": "string", "description": "| Символьный код папки для URL. Код не может содержать символ `/`." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительской папки." }, "INDEX_ID": { "type": "integer", "description": "| Идентификатор индексной страницы папки ||" }, "ACTIVE": { "type": "string", "description": "| Флаг активности папки `Y/N` ||" } }, "required": [ "siteId", "folderId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.deleteForLanding": { "post": { "summary": "Удалить все привязки страницы как специальной landing.syspage.deleteForLanding", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.syspage.deleteForLanding` удаляет все привязки, в которых страница с идентификатором `id` назначена специальной для сайта.", "operationId": "landing_syspage_deleteForLanding", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор страницы, для которой нужно удалить все специальные привязки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` в названии метода." }, "id": { "type": "integer", "description": "| Идентификатор страницы, для которой нужно удалить все специальные привязки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.deleteForSite": { "post": { "summary": "Удалить все привязки специальных страниц сайта landing.syspage.deleteForSite", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.syspage.deleteForSite` удаляет все привязки специальных страниц для сайта.", "operationId": "landing_syspage_deleteForSite", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта, для которого нужно удалить все привязки специальных страниц." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта, для которого нужно удалить все привязки специальных страниц." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.get": { "post": { "summary": "Получить список специальных страниц сайта landing.syspage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.syspage.get` возвращает список специальных страниц сайта.", "operationId": "landing_syspage_get", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/special-pages/landing-syspage-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "active": { "type": "boolean", "description": "| Возвращать только страницы, которые не удалены и активны." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "active": { "type": "boolean", "description": "| Возвращать только страницы, которые не удалены и активны." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.getSpecialPage": { "post": { "summary": "Получить адрес специальной страницы сайта landing.syspage.getSpecialPage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.syspage.getSpecialPage` возвращает URL специальной страницы сайта.", "operationId": "landing_syspage_getSpecialPage", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/special-pages/landing-syspage-get-special-page.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "integer", "description": "| Идентификатор сайта." }, "type": { "type": "string", "description": "| Код специальной страницы, который метод ищет в привязках сайта." }, "additional": { "type": "object", "description": "| Дополнительные параметры URL (подробное описание)." } }, "required": [ "siteId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "siteId": { "type": "integer", "description": "| Идентификатор сайта." }, "type": { "type": "string", "description": "| Код специальной страницы, который метод ищет в привязках сайта." }, "additional": { "type": "object", "description": "| Дополнительные параметры URL (подробное описание)." } }, "required": [ "siteId", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.set": { "post": { "summary": "Установить специальную страницу для сайта landing.syspage.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.syspage.set` назначает специальную страницу для сайта.", "operationId": "landing_syspage_set", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/page/special-pages/landing-syspage-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "type": { "type": "string", "description": "| Код специальной страницы." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно назначить специальной для сайта." } }, "required": [ "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "type": { "type": "string", "description": "| Код специальной страницы." }, "lid": { "type": "integer", "description": "| Идентификатор страницы, которую нужно назначить специальной для сайта." } }, "required": [ "id", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getLandingRef": { "post": { "summary": "Получить список включаемых областей для страницы landing.template.getLandingRef", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.template.getLandingRef` получает список включаемых областей, которые привязаны к странице.", "operationId": "landing_template_getLandingRef", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/template/landing-template-get-landing-ref.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор страницы." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getSiteRef": { "post": { "summary": "Получить список включаемых областей для сайта landing.template.getSiteRef", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.template.getSiteRef` получает список включаемых областей, которые привязаны к сайту.", "operationId": "landing_template_getSiteRef", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/template/landing-template-get-site-ref.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getlist": { "post": { "summary": "Получить список шаблонов представления landing.template.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.template.getlist` получает список шаблонов представления текущего портала по параметрам выборки.", "operationId": "landing_template_getlist", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/template/landing-template-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект параметров выборки шаблонов представления формата:" }, "select": { "type": "string", "description": "| Список полей из полей объекта Шаблон представления." }, "filter": { "type": "object", "description": "| Фильтр по полям из полей объекта Шаблон представления." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC\"}` или `{\"FIELD\": \"DESC\"}`." }, "group": { "type": "array", "items": {}, "description": "| Массив имен полей для группировки, например `[\"ACTIVE\"]` или `[\"ACTIVE\", \"SORT\"]`." }, "limit": { "type": "integer", "description": "| Максимальное количество элементов в ответе." }, "offset": { "type": "integer", "description": "| Смещение от начала выборки. Используйте вместе с `limit` для постраничной выборки ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Объект параметров выборки шаблонов представления формата:" }, "select": { "type": "string", "description": "| Список полей из полей объекта Шаблон представления." }, "filter": { "type": "object", "description": "| Фильтр по полям из полей объекта Шаблон представления." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"FIELD\": \"ASC\"}` или `{\"FIELD\": \"DESC\"}`." }, "group": { "type": "array", "items": {}, "description": "| Массив имен полей для группировки, например `[\"ACTIVE\"]` или `[\"ACTIVE\", \"SORT\"]`." }, "limit": { "type": "integer", "description": "| Максимальное количество элементов в ответе." }, "offset": { "type": "integer", "description": "| Смещение от начала выборки. Используйте вместе с `limit` для постраничной выборки ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.setLandingRef": { "post": { "summary": "Установить включаемые области для страницы landing.template.setLandingRef", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.template.setLandingRef` устанавливает привязки включаемых областей для страницы. Он работает только с привязками страницы и не изменяет привязки сайта.", "operationId": "landing_template_setLandingRef", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/template/landing-template-set-landing-ref.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор страницы." }, "data": { "type": "object", "description": "\\| `array` | Набор привязок включаемых областей страницы. (подробное описание)" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор страницы." }, "data": { "type": "object", "description": "\\| `array` | Набор привязок включаемых областей страницы. (подробное описание)" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.setSiteRef": { "post": { "summary": "Установить включаемые области для сайта landing.template.setSiteRef", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `landing.template.setSiteRef` сохраняет привязки включаемых областей для сайта. Он работает только с привязками сайта и не меняет привязки отдельных страниц.", "operationId": "landing_template_setSiteRef", "tags": [ "Сайты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/landing/template/landing-template-set-site-ref.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "data": { "type": "object", "description": "\\| `array` | Набор привязок включаемых областей сайта (подробное описание)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сайта." }, "data": { "type": "object", "description": "\\| `array` | Набор привязок включаемых областей сайта (подробное описание)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/lists.add": { "post": { "summary": "Создать универсальный список lists.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.add` создает универсальный список.", "operationId": "lists_add", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/lists/lists-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока. Возможные значения:" }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока ||" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Используйте параметр, если хотите добавить список в группу." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей списка." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив подписей к элементам и разделам списка. Поддерживаемые значения:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права." }, "DESCRIPTION": { "type": "string", "description": "| Описание списка ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Картинка. Объект в формате `{fileData: [value1, value2]}`, где `value1` — название файла картинки с расширением, `value2` — картинка в формате base64 ||" }, "BIZPROC": { "type": "string", "description": "| Включение поддержки бизнес-процессов. Возможные значения:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока. Возможные значения:" }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока ||" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Используйте параметр, если хотите добавить список в группу." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей списка." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив подписей к элементам и разделам списка. Поддерживаемые значения:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права." }, "DESCRIPTION": { "type": "string", "description": "| Описание списка ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Картинка. Объект в формате `{fileData: [value1, value2]}`, где `value1` — название файла картинки с расширением, `value2` — картинка в формате base64 ||" }, "BIZPROC": { "type": "string", "description": "| Включение поддержки бизнес-процессов. Возможные значения:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.delete": { "post": { "summary": "Удалить универсальный список lists.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.delete` удаляет универсальный список. Удаление нельзя откатить: в отличие от `lists.add` и `lists.update`, метод сразу фиксирует изменения в базе данных, даже если при удалении возникла ошибка.", "operationId": "lists_delete", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/lists/lists-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.add": { "post": { "summary": "Создать элемент универсального списка lists.element.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.element.add` создает элемент списка.", "operationId": "lists_element_add", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/elements/lists-element-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела, в который добавляется элемент." }, "LIST_ELEMENT_URL": { "type": "string", "description": "| Шаблон адреса к элементам списка." }, "PROPERTY_PropertyId": { "type": "string", "description": "| Пользовательские свойства." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела, в который добавляется элемент." }, "LIST_ELEMENT_URL": { "type": "string", "description": "| Шаблон адреса к элементам списка." }, "PROPERTY_PropertyId": { "type": "string", "description": "| Пользовательские свойства." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.delete": { "post": { "summary": "Удалить элемент универсального списка lists.element.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.element.delete` удаляет элемент списка.", "operationId": "lists_element_delete", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/elements/lists-element-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.get": { "post": { "summary": "Получить параметры элемента или список элементов lists.element.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.element.get` возвращает элемент или список элементов.", "operationId": "lists_element_get", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/elements/lists-element-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Символьный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать. Если поля не указаны, возвращаются все доступные по умолчанию." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации полей элементов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Фильтруемое поле может принимать значения:" }, "ELEMENT_ORDER": { "type": "object", "description": "| Объект для сортировки полей элементов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Символьный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "SELECT": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать. Если поля не указаны, возвращаются все доступные по умолчанию." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации полей элементов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Фильтруемое поле может принимать значения:" }, "ELEMENT_ORDER": { "type": "object", "description": "| Объект для сортировки полей элементов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.get.file.url": { "post": { "summary": "Получить путь к файлу lists.element.get.file.url", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.element.get.file.url` возвращает путь к файлу.", "operationId": "lists_element_get_file_url", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/elements/lists-element-get-file-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "FIELD_ID": { "type": "integer", "description": "| Идентификатор свойства Файл или Файл (Диск), без префикса `PROPERTY_` ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELD_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "FIELD_ID": { "type": "integer", "description": "| Идентификатор свойства Файл или Файл (Диск), без префикса `PROPERTY_` ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELD_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.update": { "post": { "summary": "Изменить элемент универсального списка lists.element.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.element.update` обновляет элемент списка.", "operationId": "lists_element_update", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/elements/lists-element-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "PROPERTY_PropertyId": { "type": "string", "description": "| Пользовательские свойства." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "ELEMENT_ID": { "type": "integer", "description": "| Идентификатор элемента." }, "ELEMENT_CODE": { "type": "string", "description": "| Символьный код элемента." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "PROPERTY_PropertyId": { "type": "string", "description": "| Пользовательские свойства." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.add": { "post": { "summary": "Создать поле универсального списка lists.field.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.field.add` создает поле списка.", "operationId": "lists_field_add", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/fields/lists-field-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив параметров." }, "TYPE": { "type": "string", "description": "| Тип поля. После создания тип поля изменить будет нельзя." }, "IS_REQUIRED": { "type": "string", "description": "| Флаг обязательности поля. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Флаг множественности поля. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Значение по умолчанию. Если включена настройка `ADD_READ_ONLY_FIELD` в `SETTINGS`, параметр становится обязательным ||" }, "LIST": { "type": "array", "items": {}, "description": "| Значения для поля типа Список. Массив в формате `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, где `'ID'` — временный идентификатор, `VALUE` — отображаемый текст, `SORT` — порядок сортировки, `DEF` — признак значения по умолчанию." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| Альтернативный способ задания значений для поля типа Список. Строка, где значения разделены символом переноса `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Значение по умолчанию для поля типа Список. Массив принимает временный идентификатор из `LIST` ||" }, "CODE": { "type": "string", "description": "| Символьный код поля. Обязателен для пользовательских полей. Для системных полей не используется ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки отображения и поведения." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Массив настроек для пользовательских полей. Структура зависит от типа поля:" }, "ROW_COUNT": { "type": "integer", "description": "| Высота поля." }, "COL_COUNT": { "type": "integer", "description": "| Ширина поля." }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор связанного списка. Обязателен для типов Привязка к разделам, Привязка к элементам и Привязка к элементам в виде списка ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив параметров." }, "TYPE": { "type": "string", "description": "| Тип поля. После создания тип поля изменить будет нельзя." }, "IS_REQUIRED": { "type": "string", "description": "| Флаг обязательности поля. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Флаг множественности поля. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Значение по умолчанию. Если включена настройка `ADD_READ_ONLY_FIELD` в `SETTINGS`, параметр становится обязательным ||" }, "LIST": { "type": "array", "items": {}, "description": "| Значения для поля типа Список. Массив в формате `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, где `'ID'` — временный идентификатор, `VALUE` — отображаемый текст, `SORT` — порядок сортировки, `DEF` — признак значения по умолчанию." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| Альтернативный способ задания значений для поля типа Список. Строка, где значения разделены символом переноса `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Значение по умолчанию для поля типа Список. Массив принимает временный идентификатор из `LIST` ||" }, "CODE": { "type": "string", "description": "| Символьный код поля. Обязателен для пользовательских полей. Для системных полей не используется ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки отображения и поведения." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Массив настроек для пользовательских полей. Структура зависит от типа поля:" }, "ROW_COUNT": { "type": "integer", "description": "| Высота поля." }, "COL_COUNT": { "type": "integer", "description": "| Ширина поля." }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор связанного списка. Обязателен для типов Привязка к разделам, Привязка к элементам и Привязка к элементам в виде списка ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.delete": { "post": { "summary": "Удалить поле из универсального списка lists.field.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.field.delete` удаляет поле из списка.", "operationId": "lists_field_delete", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/fields/lists-field-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELD_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELD_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.get": { "post": { "summary": "Получить параметры поля или список полей универсального списка lists.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.field.get` возвращает данные о поле или список полей.", "operationId": "lists_field_get", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/fields/lists-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.type.get": { "post": { "summary": "Получить доступные типы полей для универсального списка lists.field.type.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.field.type.get` возвращает список доступных типов полей для списка.", "operationId": "lists_field_type_get", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/fields/lists-field-type-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "integer", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELD_ID": { "type": "integer", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.update": { "post": { "summary": "Изменить поле универсального списка lists.field.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.field.update` обновляет поле списка.", "operationId": "lists_field_update", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/fields/lists-field-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив параметров." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." }, "TYPE": { "type": "string", "description": "| Тип поля. Изменить тип нельзя, передавайте тот, который был задан при создании поля." }, "IS_REQUIRED": { "type": "string", "description": "| Флаг обязательности поля. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Флаг множественности поля. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Значение по умолчанию. Если включена настройка `ADD_READ_ONLY_FIELD` в `SETTINGS`, параметр становится обязательным ||" }, "LIST": { "type": "array", "items": {}, "description": "| Значения для поля типа Список. Массив в формате `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, где `'ID'` — идентификатор, `VALUE` — отображаемый текст, `SORT` — порядок сортировки, `DEF` — признак значения по умолчанию." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| Альтернативный способ задания значений для поля типа Список. Строка, где значения разделены символом переноса `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Значение по умолчанию для поля типа Список. Массив принимает идентификатор из `LIST` ||" }, "CODE": { "type": "string", "description": "| Символьный код поля. Обязателен для пользовательских полей. Для системных полей не используется ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки отображения и поведения." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Массив настроек для пользовательских полей. Структура зависит от типа поля:" }, "ROW_COUNT": { "type": "integer", "description": "| Высота поля ||" }, "COL_COUNT": { "type": "integer", "description": "| Ширина поля ||" }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор связанного списка. Обязателен для типов Привязка к разделам, Привязка к элементам и Привязка к элементам в виде списка ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "FIELD_ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив параметров." }, "FIELD_ID": { "type": "string", "description": "| Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом." }, "TYPE": { "type": "string", "description": "| Тип поля. Изменить тип нельзя, передавайте тот, который был задан при создании поля." }, "IS_REQUIRED": { "type": "string", "description": "| Флаг обязательности поля. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Флаг множественности поля. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Значение по умолчанию. Если включена настройка `ADD_READ_ONLY_FIELD` в `SETTINGS`, параметр становится обязательным ||" }, "LIST": { "type": "array", "items": {}, "description": "| Значения для поля типа Список. Массив в формате `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, где `'ID'` — идентификатор, `VALUE` — отображаемый текст, `SORT` — порядок сортировки, `DEF` — признак значения по умолчанию." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| Альтернативный способ задания значений для поля типа Список. Строка, где значения разделены символом переноса `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Значение по умолчанию для поля типа Список. Массив принимает идентификатор из `LIST` ||" }, "CODE": { "type": "string", "description": "| Символьный код поля. Обязателен для пользовательских полей. Для системных полей не используется ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки отображения и поведения." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Массив настроек для пользовательских полей. Структура зависит от типа поля:" }, "ROW_COUNT": { "type": "integer", "description": "| Высота поля ||" }, "COL_COUNT": { "type": "integer", "description": "| Ширина поля ||" }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Идентификатор связанного списка. Обязателен для типов Привязка к разделам, Привязка к элементам и Привязка к элементам в виде списка ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "FIELD_ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.get": { "post": { "summary": "Получить данные универсального списка или массив списков lists.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.get` возвращает универсальный список или массив списков.", "operationId": "lists_get", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/lists/lists-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока ||" }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Обязателен для списков групп, иначе произойдет ошибка доступа." }, "IBLOCK_ORDER": { "type": "object", "description": "| Объект для сортировки полей списка в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "IBLOCK_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока ||" }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Обязателен для списков групп, иначе произойдет ошибка доступа." }, "IBLOCK_ORDER": { "type": "object", "description": "| Объект для сортировки полей списка в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "IBLOCK_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.get.iblock.type.id": { "post": { "summary": "Получить идентификатор типа инфоблока lists.get.iblock.type.id", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.get.iblock.type.id` возвращает идентификатор типа инфоблока.", "operationId": "lists_get_iblock_type_id", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/lists/lists-get-iblock-type-id.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." } }, "required": [ "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." } }, "required": [ "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.add": { "post": { "summary": "Создать раздел универсального списка lists.section.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.section.add` создает раздел списка.", "operationId": "lists_section_add", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/sections/lists-section-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Идентификатор родительского раздела." }, "SECTION_CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "EXTERNAL_ID": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Признак активности. Возможные значения:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "DESCRIPTION": { "type": "string", "description": "| Устаревший." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Устаревший." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Устаревший." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Идентификатор родительского раздела." }, "SECTION_CODE": { "type": "string", "description": "| Символьный код раздела ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "EXTERNAL_ID": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Признак активности. Возможные значения:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "DESCRIPTION": { "type": "string", "description": "| Устаревший." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Устаревший." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Устаревший." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.delete": { "post": { "summary": "Удалить раздел универсального списка lists.section.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.section.delete` удаляет раздел списка.", "operationId": "lists_section_delete", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/sections/lists-section-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела." }, "SECTION_CODE": { "type": "string", "description": "| Cимвольный код раздела." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела." }, "SECTION_CODE": { "type": "string", "description": "| Cимвольный код раздела." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.get": { "post": { "summary": "Получить параметры раздела или список разделов универсального списка lists.section.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.section.get` возвращает раздел или список разделов.", "operationId": "lists_section_get", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/sections/lists-section-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации разделов `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Фильтруемое поле может принимать значения:" }, "SELECT": { "type": "array", "items": {}, "description": "| Массив с полями для выборки. Доступные поля:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации разделов `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Фильтруемое поле может принимать значения:" }, "SELECT": { "type": "array", "items": {}, "description": "| Массив с полями для выборки. Доступные поля:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.update": { "post": { "summary": "Изменить раздел универсального списка lists.section.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.section.update` обновляет раздел списка.", "operationId": "lists_section_update", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/sections/lists-section-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела." }, "SECTION_CODE": { "type": "string", "description": "| Cимвольный код раздела." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "EXTERNAL_ID": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Признак активности. Возможные значения:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "DESCRIPTION": { "type": "string", "description": "| Устаревший." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Устаревший." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Устаревший." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SECTION_ID": { "type": "integer", "description": "| Идентификатор раздела." }, "SECTION_CODE": { "type": "string", "description": "| Cимвольный код раздела." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей." }, "EXTERNAL_ID": { "type": "string", "description": "| Внешний идентификатор раздела ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Признак активности. Возможные значения:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "DESCRIPTION": { "type": "string", "description": "| Устаревший." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Устаревший." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Устаревший." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Устаревший." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.update": { "post": { "summary": "Обновить универсальный список lists.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `lists.update` обновляет универсальный список.", "operationId": "lists_update", "tags": [ "Универсальные списки" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/lists/lists/lists-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Для изменения настроек списка указывать не нужно. Используйте параметр, если хотите перенести список в другую группу." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей списка." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив подписей к элементам и разделам списка. Поддерживаемые значения:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права." }, "DESCRIPTION": { "type": "string", "description": "| Описание списка ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Картинка. Объект в формате `{fileData: [value1, value2]}`, где `value1` — название файла картинки с расширением, `value2` — картинка в формате base64 ||" }, "BIZPROC": { "type": "string", "description": "| Включение поддержки бизнес-процессов. Возможные значения:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Идентификатор типа инфоблока." }, "IBLOCK_ID": { "type": "integer", "description": "| Идентификатор инфоблока." }, "IBLOCK_CODE": { "type": "string", "description": "| Cимвольный код инфоблока." }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Идентификатор группы. Для изменения настроек списка указывать не нужно. Используйте параметр, если хотите перенести список в другую группу." }, "FIELDS": { "type": "array", "items": {}, "description": "| Массив полей списка." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив подписей к элементам и разделам списка. Поддерживаемые значения:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права." }, "DESCRIPTION": { "type": "string", "description": "| Описание списка ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Картинка. Объект в формате `{fileData: [value1, value2]}`, где `value1` — название файла картинки с расширением, `value2` — картинка в формате base64 ||" }, "BIZPROC": { "type": "string", "description": "| Включение поддержки бизнес-процессов. Возможные значения:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/log.blogcomment.add": { "post": { "summary": "Добавить комментарий к сообщению log.blogcomment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogcomment.add` добавляет комментарий к сообщению Ленты новостей и возвращает его идентификатор. Если у пользователя есть право комментировать сообщение только с премодерацией, комментарий сохранится, но появится в Ленте после проверки модератором.", "operationId": "log_blogcomment_add", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/blogcomment/log-blogcomment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения Ленты новостей." }, "TEXT": { "type": "string", "description": "| Текст комментария. Сохраняется в поле `POST_TEXT`. Если к сообщению уже опубликован такой же комментарий без файлов, метод ответит ошибкой `Duplicate comment` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов вида `[[\"имя файла\", \"содержимое в Base64\"]]` по правилам работы с файлами. Метод загрузит файлы на Диск пользователя и прикрепит к комментарию ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого публикуется комментарий. По умолчанию — пользователь, который вызвал метод. Параметр учитывается, только если метод вызывает администратор." } }, "required": [ "POST_ID", "TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения Ленты новостей." }, "TEXT": { "type": "string", "description": "| Текст комментария. Сохраняется в поле `POST_TEXT`. Если к сообщению уже опубликован такой же комментарий без файлов, метод ответит ошибкой `Duplicate comment` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов вида `[[\"имя файла\", \"содержимое в Base64\"]]` по правилам работы с файлами. Метод загрузит файлы на Диск пользователя и прикрепит к комментарию ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого публикуется комментарий. По умолчанию — пользователь, который вызвал метод. Параметр учитывается, только если метод вызывает администратор." } }, "required": [ "POST_ID", "TEXT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogcomment.delete": { "post": { "summary": "Удалить комментарий к сообщению log.blogcomment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogcomment.delete` удаляет комментарий к сообщению Ленты новостей.", "operationId": "log_blogcomment_delete", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/blogcomment/log-blogcomment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMENT_ID": { "type": "integer", "description": "| Идентификатор комментария, больше `0`." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого выполняется удаление. По умолчанию — пользователь, который вызвал метод. Параметр учитывается, только если метод вызывает администратор." } }, "required": [ "COMMENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMENT_ID": { "type": "integer", "description": "| Идентификатор комментария, больше `0`." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого выполняется удаление. По умолчанию — пользователь, который вызвал метод. Параметр учитывается, только если метод вызывает администратор." } }, "required": [ "COMMENT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogcomment.get": { "post": { "summary": "Получить комментарии к сообщению log.blogcomment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogcomment.get` возвращает опубликованные комментарии к сообщению Ленты новостей и информацию о прикрепленных к ним файлах.", "operationId": "log_blogcomment_get", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/blogcomment/log-blogcomment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения Ленты новостей." }, "FIRST_ID": { "type": "integer", "description": "| Метод вернет комментарии с идентификаторами больше указанного значения. Комментарии сортируются по возрастанию идентификатора." }, "LAST_ID": { "type": "integer", "description": "| Метод вернет комментарии с идентификаторами меньше указанного значения. Комментарии сортируются по убыванию идентификатора." }, "LIMIT": { "type": "integer", "description": "| Количество комментариев в ответе. Максимальное значение — `1000`, большее значение заменяется на `1000`. Если значение не передано или меньше `1`, метод вернет `100` комментариев ||" } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения Ленты новостей." }, "FIRST_ID": { "type": "integer", "description": "| Метод вернет комментарии с идентификаторами больше указанного значения. Комментарии сортируются по возрастанию идентификатора." }, "LAST_ID": { "type": "integer", "description": "| Метод вернет комментарии с идентификаторами меньше указанного значения. Комментарии сортируются по убыванию идентификатора." }, "LIMIT": { "type": "integer", "description": "| Количество комментариев в ответе. Максимальное значение — `1000`, большее значение заменяется на `1000`. Если значение не передано или меньше `1`, метод вернет `100` комментариев ||" } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogcomment.user.get": { "post": { "summary": "Получить комментарии пользователя log.blogcomment.user.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogcomment.user.get` возвращает комментарии пользователя к сообщениям Ленты новостей и сведения о прикрепленных к ним файлах.", "operationId": "log_blogcomment_user_get", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/blogcomment/log-blogcomment-user-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, чьи комментарии нужно получить. Если параметр не передан или его передает не администратор, вернутся комментарии текущего пользователя." }, "FIRST_ID": { "type": "integer", "description": "| Метод вернет комментарии, у которых `id` больше этого значения. Не передавайте сюда `comment_id`: это другой идентификатор ||" }, "LAST_ID": { "type": "integer", "description": "| Метод вернет комментарии, у которых `id` меньше этого значения. Если передан и `FIRST_ID`, метод учтет только `FIRST_ID` ||" }, "LIMIT": { "type": "integer", "description": "| Сколько комментариев вернуть, от `1` до `1000`. По умолчанию `100`. Большее значение метод заменит на `1000` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, чьи комментарии нужно получить. Если параметр не передан или его передает не администратор, вернутся комментарии текущего пользователя." }, "FIRST_ID": { "type": "integer", "description": "| Метод вернет комментарии, у которых `id` больше этого значения. Не передавайте сюда `comment_id`: это другой идентификатор ||" }, "LAST_ID": { "type": "integer", "description": "| Метод вернет комментарии, у которых `id` меньше этого значения. Если передан и `FIRST_ID`, метод учтет только `FIRST_ID` ||" }, "LIMIT": { "type": "integer", "description": "| Сколько комментариев вернуть, от `1` до `1000`. По умолчанию `100`. Большее значение метод заменит на `1000` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.add": { "post": { "summary": "Добавить сообщение в Ленту новостей log.blogpost.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.add` добавляет сообщение в Ленту новостей.", "operationId": "log_blogpost_add", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "POST_TITLE": { "type": "string", "description": "| Заголовок сообщения ||" }, "DEST": { "type": "array", "items": {}, "description": "| Список адресатов, которые получат право на просмотр сообщения." }, "SPERM": { "type": "array", "items": {}, "description": "| Устаревший аналог `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов в формате, описанном в работе с файлами." }, "IMPORTANT": { "type": "string", "description": "| Признак важного сообщения." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Дата и время в формате ISO 8601, до которого сообщение будет считаться важным ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого публикуется сообщение. Доступно только администраторам." }, "TAGS": { "type": "string", "description": "| Теги сообщения ||" }, "BACKGROUND_CODE": { "type": "string", "description": "| Код фона сообщения ||" }, "PARSE_PREVIEW": { "type": "string", "description": "| Автоматическое добавление превью ссылки из текста сообщения." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Альтернатива `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Признак важного сообщения." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Срок действия важного сообщения." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Превью ссылки из текста сообщения." }, "UF_GRATITUDE": { "type": "integer", "description": "| Данные функционала Благодарность в формате:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Данные опроса в формате:" } }, "required": [ "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "POST_TITLE": { "type": "string", "description": "| Заголовок сообщения ||" }, "DEST": { "type": "array", "items": {}, "description": "| Список адресатов, которые получат право на просмотр сообщения." }, "SPERM": { "type": "array", "items": {}, "description": "| Устаревший аналог `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов в формате, описанном в работе с файлами." }, "IMPORTANT": { "type": "string", "description": "| Признак важного сообщения." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Дата и время в формате ISO 8601, до которого сообщение будет считаться важным ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого публикуется сообщение. Доступно только администраторам." }, "TAGS": { "type": "string", "description": "| Теги сообщения ||" }, "BACKGROUND_CODE": { "type": "string", "description": "| Код фона сообщения ||" }, "PARSE_PREVIEW": { "type": "string", "description": "| Автоматическое добавление превью ссылки из текста сообщения." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Альтернатива `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Признак важного сообщения." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Срок действия важного сообщения." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Превью ссылки из текста сообщения." }, "UF_GRATITUDE": { "type": "integer", "description": "| Данные функционала Благодарность в формате:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Данные опроса в формате:" } }, "required": [ "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.delete": { "post": { "summary": "Удалить сообщение Ленты новостей log.blogpost.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.delete` удаляет сообщение Ленты новостей.", "operationId": "log_blogpost_delete", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.get": { "post": { "summary": "Получить доступные пользователю сообщения Ленты новостей log.blogpost.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.get` возвращает сообщения Ленты новостей, доступные текущему пользователю.", "operationId": "log_blogpost_get", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Фильтрация по идентификатору сообщения." }, "LOG_RIGHTS": { "type": "array", "items": {}, "description": "| Фильтрация по получателям, у которых есть право на просмотр сообщения." }, "LOG_DATE_FROM": { "type": "string", "description": "| Нижняя граница периода публикации сообщения в формате ISO 8601. Задается в пользовательском времени. Если указаны `LOG_DATE_FROM` и `LOG_DATE_TO`, значение `LOG_DATE_FROM` не должно быть позже `LOG_DATE_TO`. Пустая строка не ограничивает выборку ||" }, "LOG_DATE_TO": { "type": "string", "description": "| Верхняя граница периода публикации сообщения в формате ISO 8601. Задается в пользовательском времени. Если значение не указано или передана пустая строка, верхняя граница периода не применяется ||" }, "FIRST_ID": { "type": "integer", "description": "| Идентификатор записи Ленты новостей для курсорной навигации вперед. Метод вернет сообщения с идентификаторами больше указанного значения. Если переданы `FIRST_ID` и `LAST_ID`, применяется `FIRST_ID`. Значение `0` или пустая строка начинает выборку с края списка ||" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор записи Ленты новостей для курсорной навигации назад. Метод вернет сообщения с идентификаторами меньше указанного значения. Значение `0` или пустая строка начинает выборку с края списка ||" }, "LIMIT": { "type": "integer", "description": "| Размер страницы в курсорном режиме. По умолчанию — `50`. Неположительное или нечисловое значение заменяется значением по умолчанию. Максимальное значение — `200` ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Фильтрация по идентификатору сообщения." }, "LOG_RIGHTS": { "type": "array", "items": {}, "description": "| Фильтрация по получателям, у которых есть право на просмотр сообщения." }, "LOG_DATE_FROM": { "type": "string", "description": "| Нижняя граница периода публикации сообщения в формате ISO 8601. Задается в пользовательском времени. Если указаны `LOG_DATE_FROM` и `LOG_DATE_TO`, значение `LOG_DATE_FROM` не должно быть позже `LOG_DATE_TO`. Пустая строка не ограничивает выборку ||" }, "LOG_DATE_TO": { "type": "string", "description": "| Верхняя граница периода публикации сообщения в формате ISO 8601. Задается в пользовательском времени. Если значение не указано или передана пустая строка, верхняя граница периода не применяется ||" }, "FIRST_ID": { "type": "integer", "description": "| Идентификатор записи Ленты новостей для курсорной навигации вперед. Метод вернет сообщения с идентификаторами больше указанного значения. Если переданы `FIRST_ID` и `LAST_ID`, применяется `FIRST_ID`. Значение `0` или пустая строка начинает выборку с края списка ||" }, "LAST_ID": { "type": "integer", "description": "| Идентификатор записи Ленты новостей для курсорной навигации назад. Метод вернет сообщения с идентификаторами меньше указанного значения. Значение `0` или пустая строка начинает выборку с края списка ||" }, "LIMIT": { "type": "integer", "description": "| Размер страницы в курсорном режиме. По умолчанию — `50`. Неположительное или нечисловое значение заменяется значением по умолчанию. Максимальное значение — `200` ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.getusers.important": { "post": { "summary": "Просмотреть пользователей, прочитавших важное сообщение log.blogpost.getusers.important", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.getusers.important` возвращает массив идентификаторов пользователей, которые прочитали важное сообщение.", "operationId": "log_blogpost_getusers_important", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-getusers-important.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор важного сообщения Ленты новостей." } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор важного сообщения Ленты новостей." } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.share": { "post": { "summary": "Добавить получателей в сообщение Ленты новостей log.blogpost.share", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.share` добавляет новых получателей к сообщению Ленты новостей.", "operationId": "log_blogpost_share", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-share.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "DEST": { "type": "array", "items": {}, "description": "| Список новых адресатов, которым будет выдано право на просмотр сообщения." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого редактируется сообщение. Доступно только администраторам." } }, "required": [ "POST_ID", "DEST" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "DEST": { "type": "array", "items": {}, "description": "| Список новых адресатов, которым будет выдано право на просмотр сообщения." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого редактируется сообщение. Доступно только администраторам." } }, "required": [ "POST_ID", "DEST" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.update": { "post": { "summary": "Изменить сообщение Ленты новостей log.blogpost.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `log.blogpost.update` изменяет сообщение Ленты новостей.", "operationId": "log_blogpost_update", "tags": [ "Лента новостей" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/log/log-blogpost-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "POST_MESSAGE": { "type": "string", "description": "| Новый текст сообщения ||" }, "POST_TITLE": { "type": "string", "description": "| Новый заголовок сообщения" }, "DEST": { "type": "array", "items": {}, "description": "| Новый список адресатов, которые получат право на просмотр сообщения." }, "SPERM": { "type": "array", "items": {}, "description": "| Устаревший аналог `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов в формате, описанном в работе с файлами." }, "IMPORTANT": { "type": "string", "description": "| Признак важного сообщения." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Дата и время в формате ISO 8601, до которого сообщение будет считаться важным ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого редактируется сообщение. Доступно только администраторам." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Альтернатива `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Признак важного сообщения." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Срок действия важного сообщения." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Превью ссылки из текста сообщения." }, "UF_GRATITUDE": { "type": "integer", "description": "| Данные функционала Благодарность в формате:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Данные опроса в формате:" } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Идентификатор сообщения." }, "POST_MESSAGE": { "type": "string", "description": "| Новый текст сообщения ||" }, "POST_TITLE": { "type": "string", "description": "| Новый заголовок сообщения" }, "DEST": { "type": "array", "items": {}, "description": "| Новый список адресатов, которые получат право на просмотр сообщения." }, "SPERM": { "type": "array", "items": {}, "description": "| Устаревший аналог `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Массив файлов в формате, описанном в работе с файлами." }, "IMPORTANT": { "type": "string", "description": "| Признак важного сообщения." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Дата и время в формате ISO 8601, до которого сообщение будет считаться важным ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого редактируется сообщение. Доступно только администраторам." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Альтернатива `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Признак важного сообщения." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Срок действия важного сообщения." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Превью ссылки из текста сообщения." }, "UF_GRATITUDE": { "type": "integer", "description": "| Данные функционала Благодарность в формате:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Данные опроса в формате:" } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/mail.mailbox.field.get": { "post": { "summary": "Получить поле почтового ящика mail.mailbox.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_mailbox_field_get", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/mailbox/mail-mailbox-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.mailbox.field.list": { "post": { "summary": "Получить список полей почтового ящика mail.mailbox.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_mailbox_field_list", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/mailbox/mail-mailbox-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.mailbox.get": { "post": { "summary": "Получить почтовый ящик mail.mailbox.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_mailbox_get", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/mailbox/mail-mailbox-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор почтового ящика." }, "select": { "type": "array", "items": {}, "description": "| Список полей почтового ящика, которые нужно вернуть." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор почтового ящика." }, "select": { "type": "array", "items": {}, "description": "| Список полей почтового ящика, которые нужно вернуть." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.mailbox.list": { "post": { "summary": "Получить список почтовых ящиков mail.mailbox.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_mailbox_list", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/mailbox/mail-mailbox-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "| Фрагмент электронной почты для фильтрации ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "| Фрагмент электронной почты для фильтрации ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.mailbox.senders": { "post": { "summary": "Получить отправителей mail.mailbox.senders", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_mailbox_senders", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/mailbox/mail-mailbox-senders.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.createcalendarevent": { "post": { "summary": "Создать событие календаря из письма mail.message.createcalendarevent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_createcalendarevent", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-createcalendarevent.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "dateFrom": { "type": "string", "description": "| Дата и время начала события в формате `Y-m-d H:i:s`, например `2026-04-15 10:00:00` ||" }, "dateTo": { "type": "string", "description": "| Дата и время окончания события в формате `Y-m-d H:i:s`, например `2026-04-15 11:00:00` ||" }, "description": { "type": "string", "description": "| Описание события ||" } }, "required": [ "messageId", "dateFrom", "dateTo" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "dateFrom": { "type": "string", "description": "| Дата и время начала события в формате `Y-m-d H:i:s`, например `2026-04-15 10:00:00` ||" }, "dateTo": { "type": "string", "description": "| Дата и время окончания события в формате `Y-m-d H:i:s`, например `2026-04-15 11:00:00` ||" }, "description": { "type": "string", "description": "| Описание события ||" } }, "required": [ "messageId", "dateFrom", "dateTo" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.createchat": { "post": { "summary": "Создать чат из письма mail.message.createchat", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_createchat", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-createchat.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.createcrmactivity": { "post": { "summary": "Создать дело CRM из письма mail.message.createcrmactivity", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_createcrmactivity", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-createcrmactivity.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.createfeedpost": { "post": { "summary": "Создать сообщение Ленты новостей из письма mail.message.createfeedpost", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_createfeedpost", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-createfeedpost.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "title": { "type": "string", "description": "| Заголовок сообщения." } }, "required": [ "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "title": { "type": "string", "description": "| Заголовок сообщения." } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.createtask": { "post": { "summary": "Создать задачу из письма mail.message.createtask", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_createtask", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-createtask.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "title": { "type": "string", "description": "| Название задачи." }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного." }, "description": { "type": "string", "description": "| Описание задачи ||" } }, "required": [ "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." }, "title": { "type": "string", "description": "| Название задачи." }, "responsibleId": { "type": "integer", "description": "| Идентификатор ответственного." }, "description": { "type": "string", "description": "| Описание задачи ||" } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.field.get": { "post": { "summary": "Получить поле письма mail.message.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_field_get", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.field.list": { "post": { "summary": "Получить список полей письма mail.message.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_field_list", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.forward": { "post": { "summary": "Переслать письмо mail.message.forward", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_forward", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-forward.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "forwardMessageId": { "type": "integer", "description": "| Идентификатор письма, которое нужно переслать." }, "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "forwardMessageId", "from", "to", "subject", "body" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "forwardMessageId": { "type": "integer", "description": "| Идентификатор письма, которое нужно переслать." }, "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "forwardMessageId", "from", "to", "subject", "body" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.get": { "post": { "summary": "Получить письмо mail.message.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_get", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор письма." }, "select": { "type": "array", "items": {}, "description": "| Список полей письма, которые нужно вернуть." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор письма." }, "select": { "type": "array", "items": {}, "description": "| Список полей письма, которые нужно вернуть." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.list": { "post": { "summary": "Получить список писем mail.message.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_list", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mailboxId": { "type": "integer", "description": "| Идентификатор почтового ящика." }, "searchQuery": { "type": "string", "description": "| Строка для поиска писем по содержимому и метаданным письма ||" }, "dateFrom": { "type": "string", "description": "| Начало периода выборки писем в формате ISO 8601, например `2026-01-01T00:00:00+03:00` ||" }, "dateTo": { "type": "string", "description": "| Конец периода выборки писем в формате ISO 8601, например `2026-01-31T23:59:59+03:00` ||" }, "isSeen": { "type": "boolean", "description": "| Фильтр по признаку прочтения письма." }, "hasAttachments": { "type": "boolean", "description": "| Фильтр по наличию вложений." }, "folder": { "type": "string", "description": "| Имя или путь почтовой папки ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "mailboxId": { "type": "integer", "description": "| Идентификатор почтового ящика." }, "searchQuery": { "type": "string", "description": "| Строка для поиска писем по содержимому и метаданным письма ||" }, "dateFrom": { "type": "string", "description": "| Начало периода выборки писем в формате ISO 8601, например `2026-01-01T00:00:00+03:00` ||" }, "dateTo": { "type": "string", "description": "| Конец периода выборки писем в формате ISO 8601, например `2026-01-31T23:59:59+03:00` ||" }, "isSeen": { "type": "boolean", "description": "| Фильтр по признаку прочтения письма." }, "hasAttachments": { "type": "boolean", "description": "| Фильтр по наличию вложений." }, "folder": { "type": "string", "description": "| Имя или путь почтовой папки ||" }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.movetofolder": { "post": { "summary": "Переместить письма в папку mail.message.movetofolder", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_movetofolder", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-movetofolder.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов писем." }, "action": { "type": "string", "description": "| Действие для писем:" }, "folder": { "type": "string", "description": "| Имя или путь существующей папки в этом почтовом ящике." } }, "required": [ "messageIds", "action" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов писем." }, "action": { "type": "string", "description": "| Действие для писем:" }, "folder": { "type": "string", "description": "| Имя или путь существующей папки в этом почтовом ящике." } }, "required": [ "messageIds", "action" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.removecrmactivity": { "post": { "summary": "Удалить связь письма с делом CRM mail.message.removecrmactivity", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_removecrmactivity", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-removecrmactivity.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "messageId": { "type": "integer", "description": "| Идентификатор письма." } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.reply": { "post": { "summary": "Ответить на письмо mail.message.reply", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_reply", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-reply.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "replyToMessageId": { "type": "integer", "description": "| Идентификатор письма, на которое нужно ответить." }, "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "replyToMessageId", "from", "to", "subject", "body" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "replyToMessageId": { "type": "integer", "description": "| Идентификатор письма, на которое нужно ответить." }, "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "replyToMessageId", "from", "to", "subject", "body" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.send": { "post": { "summary": "Отправить письмо mail.message.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_send", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "from", "to", "subject", "body" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "from": { "type": "string", "description": "| E-mail отправителя." }, "to": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей ||" }, "subject": { "type": "string", "description": "| Тема письма ||" }, "body": { "type": "string", "description": "| Текст письма: обычный текст или базовый HTML ||" }, "cc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей копии ||" }, "bcc": { "type": "array", "items": {}, "description": "| Массив email-адресов получателей скрытой копии ||" } }, "required": [ "from", "to", "subject", "body" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.message.thread": { "post": { "summary": "Получить цепочку писем mail.message.thread", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_message_thread", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-thread.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор любого письма из цепочки." }, "limit": { "type": "integer", "description": "| Максимальное количество писем в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор любого письма из цепочки." }, "limit": { "type": "integer", "description": "| Максимальное количество писем в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.recipient.field.get": { "post": { "summary": "Получить поле получателя mail.recipient.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_recipient_field_get", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/recipient/mail-recipient-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.recipient.field.list": { "post": { "summary": "Получить список полей получателя mail.recipient.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_recipient_field_list", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/recipient/mail-recipient-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.recipient.listcontacts": { "post": { "summary": "Получить список контактов mail.recipient.listcontacts", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_recipient_listcontacts", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/recipient/mail-recipient-listcontacts.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковая строка по имени или электронной почте контакта." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковая строка по имени или электронной почте контакта." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mail.recipient.listemployees": { "post": { "summary": "Получить список сотрудников mail.recipient.listemployees", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "mail_recipient_listemployees", "tags": [ "mail" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mail/recipient/mail-recipient-listemployees.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковая строка по имени или электронной почте сотрудника." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "query" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковая строка по имени или электронной почте сотрудника." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mail" ] } ] } }, "/mailservice.add": { "post": { "summary": "Создать почтовый сервис mailservice.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.add` создает почтовый сервис для текущего Битрикс24.", "operationId": "mailservice_add", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "description": "| Признак активности сервиса. Допустимые значения:" }, "SERVER": { "type": "string", "description": "| Адрес IMAP-сервера, например `imap.my-mail.ru`. Сохраняется в нижнем регистре ||" }, "PORT": { "type": "integer", "description": "| Порт IMAP-сервера ||" }, "ENCRYPTION": { "type": "string", "description": "| Признак защищенного подключения. Допустимые значения:" }, "LINK": { "type": "string", "description": "| Адрес веб-интерфейса почтового сервиса ||" }, "ICON": { "type": "array", "items": {}, "description": "\\|`integer` | Логотип сервиса. Передайте массив из имени файла и содержимого в Base64, например `[\"logo.png\", \"iVBORw0KGgo...\"]`, или идентификатор уже загруженного файла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Значение по умолчанию: `100` ||" } }, "required": [ "ENCRYPTION" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "description": "| Признак активности сервиса. Допустимые значения:" }, "SERVER": { "type": "string", "description": "| Адрес IMAP-сервера, например `imap.my-mail.ru`. Сохраняется в нижнем регистре ||" }, "PORT": { "type": "integer", "description": "| Порт IMAP-сервера ||" }, "ENCRYPTION": { "type": "string", "description": "| Признак защищенного подключения. Допустимые значения:" }, "LINK": { "type": "string", "description": "| Адрес веб-интерфейса почтового сервиса ||" }, "ICON": { "type": "array", "items": {}, "description": "\\|`integer` | Логотип сервиса. Передайте массив из имени файла и содержимого в Base64, например `[\"logo.png\", \"iVBORw0KGgo...\"]`, или идентификатор уже загруженного файла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки. Значение по умолчанию: `100` ||" } }, "required": [ "ENCRYPTION" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.delete": { "post": { "summary": "Удалить почтовый сервис mailservice.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.delete` удаляет почтовый сервис по идентификатору.", "operationId": "mailservice_delete", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.fields": { "post": { "summary": "Получить поля почтового сервиса mailservice.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.fields` возвращает названия полей почтового сервиса на языке Битрикс24. Названия подходят для подписей в интерфейсе. Полей SMTP и `UPLOAD_OUTGOING` в ответе нет.", "operationId": "mailservice_fields", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.get": { "post": { "summary": "Получить почтовый сервис mailservice.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.get` возвращает параметры почтового сервиса текущего сайта по его идентификатору. Метод возвращает и неактивный сервис.", "operationId": "mailservice_get", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.list": { "post": { "summary": "Получить список почтовых сервисов mailservice.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.list` возвращает список активных почтовых сервисов текущего сайта.", "operationId": "mailservice_list", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.update": { "post": { "summary": "Изменить почтовый сервис mailservice.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `mailservice.update` изменяет параметры почтового сервиса текущего сайта. Передавайте только поля, которые нужно изменить: остальные поля сохраняют прежние значения.", "operationId": "mailservice_update", "tags": [ "Почтовые сервисы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." }, "ACTIVE": { "type": "string", "description": "| Признак активности сервиса. Допустимые значения:" }, "SERVER": { "type": "string", "description": "| Адрес IMAP-сервера, например `imap.my-mail.ru`. Сохраняется в нижнем регистре ||" }, "PORT": { "type": "integer", "description": "| Порт IMAP-сервера ||" }, "ENCRYPTION": { "type": "string", "description": "| Признак защищенного подключения. Допустимые значения:" }, "LINK": { "type": "string", "description": "| Адрес веб-интерфейса сервиса ||" }, "ICON": { "type": "array", "items": {}, "description": "\\|`integer` | Логотип сервиса. Передайте массив из имени файла и содержимого в Base64, например `[\"logo.png\", \"iVBORw0KGgo...\"]`, или идентификатор уже загруженного файла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор почтового сервиса." }, "ACTIVE": { "type": "string", "description": "| Признак активности сервиса. Допустимые значения:" }, "SERVER": { "type": "string", "description": "| Адрес IMAP-сервера, например `imap.my-mail.ru`. Сохраняется в нижнем регистре ||" }, "PORT": { "type": "integer", "description": "| Порт IMAP-сервера ||" }, "ENCRYPTION": { "type": "string", "description": "| Признак защищенного подключения. Допустимые значения:" }, "LINK": { "type": "string", "description": "| Адрес веб-интерфейса сервиса ||" }, "ICON": { "type": "array", "items": {}, "description": "\\|`integer` | Логотип сервиса. Передайте массив из имени файла и содержимого в Base64, например `[\"logo.png\", \"iVBORw0KGgo...\"]`, или идентификатор уже загруженного файла ||" }, "SORT": { "type": "integer", "description": "| Индекс сортировки ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/main.eventlog.field.get": { "post": { "summary": "Получить поле журнала событий main.eventlog.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "main_eventlog_field_get", "tags": [ "event-log" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/event-log/main-eventlog-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.field.list": { "post": { "summary": "Получить список полей журнала событий main.eventlog.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "main_eventlog_field_list", "tags": [ "event-log" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/event-log/main-eventlog-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.get": { "post": { "summary": "Получить запись журнала main.eventlog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "main_eventlog_get", "tags": [ "event-log" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/event-log/main-eventlog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи журнала ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи журнала ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.list": { "post": { "summary": "Получить список записей журнала main.eventlog.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "main_eventlog_list", "tags": [ "event-log" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/event-log/main-eventlog-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.tail": { "post": { "summary": "Получить новые записи журнала main.eventlog.tail", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "main_eventlog_tail", "tags": [ "event-log" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/event-log/main-eventlog-tail.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "cursor": { "type": "object", "description": "| Точка отсчета для получения новых записей:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "cursor": { "type": "object", "description": "| Точка отсчета для получения новых записей:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/messageservice.message.status.update": { "post": { "summary": "Обновить статус доставки сообщения messageservice.message.status.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `messageservice.message.status.update` обновляет статус доставки сообщения, отправленного через провайдер сообщений.", "operationId": "messageservice_message_status_update", "tags": [ "Провайдеры сообщений" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-message-status-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." }, "MESSAGE_ID": { "type": "string", "description": "| Внешний идентификатор сообщения, полученный обработчиком приложения при отправке сообщения ||" }, "STATUS": { "type": "string", "description": "| Новый статус сообщения." } }, "required": [ "CODE", "MESSAGE_ID", "STATUS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." }, "MESSAGE_ID": { "type": "string", "description": "| Внешний идентификатор сообщения, полученный обработчиком приложения при отправке сообщения ||" }, "STATUS": { "type": "string", "description": "| Новый статус сообщения." } }, "required": [ "CODE", "MESSAGE_ID", "STATUS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.add": { "post": { "summary": "Зарегистрировать СМС-провайдер или провайдер сообщений messageservice.sender.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `messageservice.sender.add` регистрирует нового провайдера сообщений.", "operationId": "messageservice_sender_add", "tags": [ "Провайдеры сообщений" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-sender-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." }, "TYPE": { "type": "string", "description": "| Тип провайдера." }, "HANDLER": { "type": "string", "description": "| URL обработчика приложения, который вызывается при отправке сообщения." } }, "required": [ "CODE", "TYPE", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." }, "TYPE": { "type": "string", "description": "| Тип провайдера." }, "HANDLER": { "type": "string", "description": "| URL обработчика приложения, который вызывается при отправке сообщения." } }, "required": [ "CODE", "TYPE", "HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.delete": { "post": { "summary": "Удалить СМС-провайдер или провайдер сообщений messageservice.sender.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `messageservice.sender.delete` удаляет зарегистрированный ранее провайдер сообщений текущего приложения.", "operationId": "messageservice_sender_delete", "tags": [ "Провайдеры сообщений" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-sender-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера." } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.list": { "post": { "summary": "Получить список СМС-провайдеров или провайдеров сообщений messageservice.sender.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `messageservice.sender.list` возвращает список кодов провайдеров, зарегистрированных текущим приложением.", "operationId": "messageservice_sender_list", "tags": [ "Провайдеры сообщений" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-sender-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.update": { "post": { "summary": "Обновить провайдер сообщений messageservice.sender.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `messageservice.sender.update` обновляет данные зарегистрированного провайдера сообщений.", "operationId": "messageservice_sender_update", "tags": [ "Провайдеры сообщений" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-sender-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера, который нужно обновить." }, "HANDLER": { "type": "string", "description": "| Новый URL обработчика приложения ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код провайдера, который нужно обновить." }, "HANDLER": { "type": "string", "description": "| Новый URL обработчика приложения ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/method.get": { "post": { "summary": "Проверить доступность метода method.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `method.get` проверяет, есть ли метод в Битрикс24 и можно ли вызвать его с текущими scope.", "operationId": "method_get", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/system/method-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/mycompanyrequisite.get": { "post": { "summary": "Получить реквизит моей компании в элементе v 3.0 crm.<тип>.mycompanyrequisite.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "mycompanyrequisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-my-company-requisite-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки или счета." }, "select": { "type": "array", "items": {}, "description": "| Список полей ответа: `requisiteId`, `bankRequisiteId`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки или счета." }, "select": { "type": "array", "items": {}, "description": "| Список полей ответа: `requisiteId`, `bankRequisiteId`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/mycompanyrequisite.set": { "post": { "summary": "Выбрать реквизит моей компании в элементе v 3.0 crm.<тип>.mycompanyrequisite.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "mycompanyrequisite_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-my-company-requisite-set-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки или счета." }, "fields": { "type": "object", "description": "| Выбранная пара реквизитов:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор сделки или счета." }, "fields": { "type": "object", "description": "| Выбранная пара реквизитов:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/note.collection.add": { "post": { "summary": "Создать базу знаний note.collection.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_add", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой базы знаний. Описание структуры объекта ||" }, "position": { "type": "integer", "description": "| Позиция базы знаний в общем списке." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями новой базы знаний. Описание структуры объекта ||" }, "position": { "type": "integer", "description": "| Позиция базы знаний в общем списке." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.archive": { "post": { "summary": "Архивировать базу знаний note.collection.archive", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_archive", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-archive.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.delete": { "post": { "summary": "Переместить базу знаний в корзину note.collection.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_delete", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.field.get": { "post": { "summary": "Получить поле базы знаний note.collection.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_field_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.field.list": { "post": { "summary": "Получить список полей базы знаний note.collection.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_field_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.get": { "post": { "summary": "Получить базу знаний note.collection.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.list": { "post": { "summary": "Получить список баз знаний note.collection.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно только по полю `state`. Описание поля." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей базы знаний, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"state\"]`. Имена полей совпадают с полями ответа." }, "state": { "type": "string", "description": "| Состояние базы знаний. Поддерживаются операторы `=` и `in`." }, "limit": { "type": "integer", "description": "| Размер страницы." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа. Описание структуры объекта." }, "position": { "type": "integer", "description": "| Значение поля `position` последней базы знаний из предыдущей страницы." }, "id": { "type": "integer", "description": "| Идентификатор последней базы знаний из предыдущей страницы." } }, "required": [ "position", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Фильтровать можно только по полю `state`. Описание поля." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей базы знаний, которые нужно вернуть в ответе, например `[\"id\",\"name\",\"state\"]`. Имена полей совпадают с полями ответа." }, "state": { "type": "string", "description": "| Состояние базы знаний. Поддерживаются операторы `=` и `in`." }, "limit": { "type": "integer", "description": "| Размер страницы." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа. Описание структуры объекта." }, "position": { "type": "integer", "description": "| Значение поля `position` последней базы знаний из предыдущей страницы." }, "id": { "type": "integer", "description": "| Идентификатор последней базы знаний из предыдущей страницы." } }, "required": [ "position", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.move": { "post": { "summary": "Изменить позицию базы знаний note.collection.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_move", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-move.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." }, "position": { "type": "integer", "description": "| Вес сортировки базы знаний. Базы знаний с большим весом располагаются выше. Чтобы поставить базу знаний между двумя другими, передайте число между их значениями `position`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." }, "position": { "type": "integer", "description": "| Вес сортировки базы знаний. Базы знаний с большим весом располагаются выше. Чтобы поставить базу знаний между двумя другими, передайте число между их значениями `position`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.restore": { "post": { "summary": "Восстановить базу знаний из корзины note.collection.restore", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_restore", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-restore.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний в корзине." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний в корзине." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.unarchive": { "post": { "summary": "Вернуть базу знаний из архива note.collection.unarchive", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_unarchive", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-unarchive.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний в архиве." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний в архиве." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.collection.update": { "post": { "summary": "Переименовать базу знаний note.collection.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_collection_update", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/collection/note-collection-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." }, "fields": { "type": "object", "description": "| Объект с полями, которые нужно изменить. Описание структуры объекта ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор базы знаний." }, "fields": { "type": "object", "description": "| Объект с полями, которые нужно изменить. Описание структуры объекта ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.add": { "post": { "summary": "Создать документ note.document.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_add", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового документа. Описание структуры объекта ||" }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний." }, "title": { "type": "string", "description": "| Заголовок документа." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского документа." }, "markdown": { "type": "string", "description": "| Начальное содержимое документа в Markdown." } }, "required": [ "fields", "collectionId", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового документа. Описание структуры объекта ||" }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний." }, "title": { "type": "string", "description": "| Заголовок документа." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского документа." }, "markdown": { "type": "string", "description": "| Начальное содержимое документа в Markdown." } }, "required": [ "fields", "collectionId", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.archive": { "post": { "summary": "Архивировать документ note.document.archive", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_archive", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-archive.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.delete": { "post": { "summary": "Переместить документ в корзину note.document.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_delete", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.field.get": { "post": { "summary": "Получить поле документа note.document.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_field_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.field.list": { "post": { "summary": "Получить список полей документа note.document.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_field_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.get": { "post": { "summary": "Получить документ note.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.list": { "post": { "summary": "Получить список документов note.document.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Описание полей фильтра." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта." }, "select": { "type": "array", "items": {}, "description": "| Список полей документа, которые нужно вернуть в ответе. Имена полей совпадают с полями ответа, например `[\"id\",\"title\",\"state\"]`." }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний. Значение `0` возвращает документы без базы знаний — документы в корзине, база знаний которых удалена окончательно." }, "state": { "type": "string", "description": "| Состояние документа. Поддерживаются операторы `=` и `in`." }, "limit": { "type": "integer", "description": "| Количество документов на странице." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа без изменений." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр списка в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Описание полей фильтра." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта." }, "select": { "type": "array", "items": {}, "description": "| Список полей документа, которые нужно вернуть в ответе. Имена полей совпадают с полями ответа, например `[\"id\",\"title\",\"state\"]`." }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний. Значение `0` возвращает документы без базы знаний — документы в корзине, база знаний которых удалена окончательно." }, "state": { "type": "string", "description": "| Состояние документа. Поддерживаются операторы `=` и `in`." }, "limit": { "type": "integer", "description": "| Количество документов на странице." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа без изменений." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.move": { "post": { "summary": "Переместить документ note.document.move", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_move", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-move.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "collectionId": { "type": "integer", "description": "| Идентификатор целевой базы знаний. База знаний должна быть активной: в архивную базу знаний переместить документ нельзя." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского документа в целевой базе знаний." }, "position": { "type": "integer", "description": "| Вес сортировки среди соседних документов. Документы с большим весом располагаются выше. Чтобы поставить документ между двумя соседями, передайте число между их значениями `position`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "collectionId": { "type": "integer", "description": "| Идентификатор целевой базы знаний. База знаний должна быть активной: в архивную базу знаний переместить документ нельзя." }, "parentId": { "type": "integer", "description": "| Идентификатор родительского документа в целевой базе знаний." }, "position": { "type": "integer", "description": "| Вес сортировки среди соседних документов. Документы с большим весом располагаются выше. Чтобы поставить документ между двумя соседями, передайте число между их значениями `position`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.restore": { "post": { "summary": "Восстановить документ из корзины note.document.restore", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_restore", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-restore.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа в корзине." }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний, в которую нужно восстановить документ. Нужно право «Редактирование» для этой базы знаний. В архивную базу знаний восстановить документ нельзя." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа в корзине." }, "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний, в которую нужно восстановить документ. Нужно право «Редактирование» для этой базы знаний. В архивную базу знаний восстановить документ нельзя." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.search.field.get": { "post": { "summary": "Получить поле поиска документов note.document.search.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_search_field_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-search-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.search.field.list": { "post": { "summary": "Получить список полей поиска документов note.document.search.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_search_field_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-search-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.search.list": { "post": { "summary": "Найти документы note.document.search.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_search_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-search-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковый запрос." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Размер страницы." } }, "required": [ "query" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "| Поисковый запрос." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта ||" }, "limit": { "type": "integer", "description": "| Размер страницы." } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.tree.field.get": { "post": { "summary": "Получить поле дерева документов note.document.tree.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_tree_field_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-tree-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.tree.field.list": { "post": { "summary": "Получить список полей дерева документов note.document.tree.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_tree_field_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-tree-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.tree.list": { "post": { "summary": "Получить дерево документов note.document.tree.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_tree_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-tree-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "collectionId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "collectionId": { "type": "integer", "description": "| Идентификатор базы знаний." } }, "required": [ "collectionId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.unarchive": { "post": { "summary": "Вернуть документ из архива note.document.unarchive", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_unarchive", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-unarchive.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа в архиве." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа в архиве." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.document.update": { "post": { "summary": "Обновить документ note.document.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_document_update", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/document/note-document-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "fields": { "type": "object", "description": "| Объект с полями, которые нужно изменить. Описание структуры объекта ||" }, "overwrite": { "type": "boolean", "description": "| Определяет, нужно ли принудительно перезаписать содержимое документа, если у него есть несохраненные изменения совместного редактора." }, "title": { "type": "string", "description": "| Новый заголовок документа." }, "markdown": { "type": "string", "description": "| Новое содержимое документа в Markdown." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор документа." }, "fields": { "type": "object", "description": "| Объект с полями, которые нужно изменить. Описание структуры объекта ||" }, "overwrite": { "type": "boolean", "description": "| Определяет, нужно ли принудительно перезаписать содержимое документа, если у него есть несохраненные изменения совместного редактора." }, "title": { "type": "string", "description": "| Новый заголовок документа." }, "markdown": { "type": "string", "description": "| Новое содержимое документа в Markdown." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.file.add": { "post": { "summary": "Загрузить файл в документ note.file.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_file_add", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/file/note-file-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "integer", "description": "| Идентификатор документа, к которому нужно привязать файл." }, "fileName": { "type": "string", "description": "| Имя файла с расширением." }, "fileContent": { "type": "string", "description": "| Бинарное содержимое файла в кодировке Base64." } }, "required": [ "documentId", "fileName", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentId": { "type": "integer", "description": "| Идентификатор документа, к которому нужно привязать файл." }, "fileName": { "type": "string", "description": "| Имя файла с расширением." }, "fileContent": { "type": "string", "description": "| Бинарное содержимое файла в кодировке Base64." } }, "required": [ "documentId", "fileName", "fileContent" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.file.field.get": { "post": { "summary": "Получить поле файла документа note.file.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_file_field_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/file/note-file-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.file.field.list": { "post": { "summary": "Получить список полей файла документа note.file.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_file_field_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/file/note-file-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив строк с именами свойств описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.file.get": { "post": { "summary": "Получить данные файла документа note.file.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_file_get", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/file/note-file-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "documentId": { "type": "integer", "description": "| Идентификатор документа, к которому привязан файл." } }, "required": [ "id", "documentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор файла." }, "documentId": { "type": "integer", "description": "| Идентификатор документа, к которому привязан файл." } }, "required": [ "id", "documentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/note.file.list": { "post": { "summary": "Получить список файлов документа note.file.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "note_file_list", "tags": [ "note" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/note/file/note-file-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "integer", "description": "| Идентификатор документа." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта." }, "limit": { "type": "integer", "description": "| Количество файлов на странице." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа без изменений." } }, "required": [ "documentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentId": { "type": "integer", "description": "| Идентификатор документа." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание структуры объекта." }, "limit": { "type": "integer", "description": "| Количество файлов на странице." }, "afterCursor": { "type": "object", "description": "| Курсор следующей страницы. Передавайте значение `result.nextCursor` из предыдущего ответа без изменений." } }, "required": [ "documentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "note" ] } ] } }, "/placement.bind": { "post": { "summary": "Зарегистрировать обработчик виджета placement.bind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `placement.bind` регистрирует обработчик виджета в точке встраивания.", "operationId": "placement_bind", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/placement-bind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PLACEMENT": { "type": "string", "description": "| Код точки встраивания. Метод приводит его к верхнему регистру. Код должен быть доступен приложению с учетом его scope ||" }, "HANDLER": { "type": "string", "description": "| URL обработчика виджета. Укажите адрес со схемой `http` или `https` и именем хоста, содержащим точку ||" }, "TITLE": { "type": "string", "description": "| Название виджета в интерфейсе. В зависимости от точки встраивания это может быть название вкладки в форме, название пункта меню и т.д. ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета в интерфейсе. На практике не используется ||" }, "GROUP_NAME": { "type": "string", "description": "| Позволяет объединять элементы пользовательского интерфейса для нескольких обработчиков одного и того же типа виджета в группу. Например, несколько пунктов выпадающего меню в верхней кнопке карточки CRM. Поддерживается только некоторыми типами виджетов ||" }, "LANG_ALL": { "type": "object", "description": "| Объект с параметрами `TITLE`, `DESCRIPTION` и `GROUP_NAME` для указанных языков. Если передан непустой `LANG_ALL`, метод использует его вместо одноименных параметров верхнего уровня. Пользователи, у которых в интерфейсе Битрикс24 выбран один из таких языков, увидят локализованные версии названи..." }, "OPTIONS": { "type": "object", "description": "| Дополнительные параметры отображения виджета. Конкретные значения зависят от точки встраивания. На текущий момент используется в виджетах для мессенджера, в виджете `PAGE_BACKGROUND_WORKER` и в виджете CRM_XXX_DETAIL_ACTIVITY. Точки встраивания, которые не принимают `OPTIONS`, например `CRM_DEA..." }, "ICON": { "type": "object", "description": "| Изображение обработчика. Передайте поле `fileData` — массив из имени файла и его содержимого в кодировке base64. Метод сохранит файл как иконку зарегистрированного обработчика ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24, для которого будет доступен зарегистрированный виджет. Возможные значение можно получить с помощью метода user.get" } }, "required": [ "PLACEMENT", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PLACEMENT": { "type": "string", "description": "| Код точки встраивания. Метод приводит его к верхнему регистру. Код должен быть доступен приложению с учетом его scope ||" }, "HANDLER": { "type": "string", "description": "| URL обработчика виджета. Укажите адрес со схемой `http` или `https` и именем хоста, содержащим точку ||" }, "TITLE": { "type": "string", "description": "| Название виджета в интерфейсе. В зависимости от точки встраивания это может быть название вкладки в форме, название пункта меню и т.д. ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание виджета в интерфейсе. На практике не используется ||" }, "GROUP_NAME": { "type": "string", "description": "| Позволяет объединять элементы пользовательского интерфейса для нескольких обработчиков одного и того же типа виджета в группу. Например, несколько пунктов выпадающего меню в верхней кнопке карточки CRM. Поддерживается только некоторыми типами виджетов ||" }, "LANG_ALL": { "type": "object", "description": "| Объект с параметрами `TITLE`, `DESCRIPTION` и `GROUP_NAME` для указанных языков. Если передан непустой `LANG_ALL`, метод использует его вместо одноименных параметров верхнего уровня. Пользователи, у которых в интерфейсе Битрикс24 выбран один из таких языков, увидят локализованные версии названи..." }, "OPTIONS": { "type": "object", "description": "| Дополнительные параметры отображения виджета. Конкретные значения зависят от точки встраивания. На текущий момент используется в виджетах для мессенджера, в виджете `PAGE_BACKGROUND_WORKER` и в виджете CRM_XXX_DETAIL_ACTIVITY. Точки встраивания, которые не принимают `OPTIONS`, например `CRM_DEA..." }, "ICON": { "type": "object", "description": "| Изображение обработчика. Передайте поле `fileData` — массив из имени файла и его содержимого в кодировке base64. Метод сохранит файл как иконку зарегистрированного обработчика ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24, для которого будет доступен зарегистрированный виджет. Возможные значение можно получить с помощью метода user.get" } }, "required": [ "PLACEMENT", "HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/placement.get": { "post": { "summary": "Получить обработчики, зарегистрированные приложением placement.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `placement.get` возвращает список обработчиков виджетов, которые приложение зарегистрировало методом [placement.bind](./placement-bind.md). Для каждого обработчика метод отдает код точки встраивания, адрес обработчика, пользователя, для которого зарегистрирован виджет, настройки и названия на разных языках.", "operationId": "placement_get", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/placement-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/placement.list": { "post": { "summary": "Получить точки встраивания, доступные приложению placement.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `placement.list` возвращает коды точек встраивания, которые приложение может зарегистрировать методом [placement.bind](./placement-bind.md). Обработчики, которые приложение уже зарегистрировало, возвращает метод [placement.get](./placement-get.md).", "operationId": "placement_list", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/placement-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| Код scope, для которого нужно получить точки встраивания, например `crm`, `task` или `sonet_group`. Коды перечислены на странице Доступные скоупы Битрикс24." }, "FULL": { "type": "boolean", "description": "| Флаг получения полного списка точек встраивания." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| Код scope, для которого нужно получить точки встраивания, например `crm`, `task` или `sonet_group`. Коды перечислены на странице Доступные скоупы Битрикс24." }, "FULL": { "type": "boolean", "description": "| Флаг получения полного списка точек встраивания." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/placement.unbind": { "post": { "summary": "Удалить обработчик виджета placement.unbind", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `placement.unbind` удаляет зарегистрированный обработчик виджета.", "operationId": "placement_unbind", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/placement-unbind.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "HANDLER": { "type": "string", "description": "| URL обработчика виджета." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24, для которого был зарегистрирован обработчик." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "HANDLER": { "type": "string", "description": "| URL обработчика виджета." }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя Битрикс24, для которого был зарегистрирован обработчик." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/productrow.add": { "post": { "summary": "Добавить товарную позицию v 3.0 crm.<тип>.productrow.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями товарной позиции в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в который добавляется позиция. Тип элемента задает имя метода: `crm.deal.productrow.add` добавляет позицию в сделку." }, "productId": { "type": "integer", "description": "| Идентификатор товара из каталога. Если не передать `productName`, название позиции берется из каталога." }, "productName": { "type": "string", "description": "| Название позиции. Для позиции без товара из каталога передайте название явно ||" }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом скидки и налога ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Скидка в процентах. Используйте, если `discountTypeId` равно `2` ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Сумма скидки на единицу товара. Используйте, если `discountTypeId` равно `1`. При скидке в процентах сумма рассчитывается автоматически ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах, например `20`. Без значения позиция считается без налога." }, "taxIncluded": { "type": "boolean", "description": "| Включен ли налог в цену." }, "measureCode": { "type": "integer", "description": "| Код единицы измерения по классификатору, например `796` — штука. Название единицы в `measureName` подставляется по коду." }, "measureName": { "type": "string", "description": "| Название единицы измерения. Если передан `measureCode`, название берется из справочника единиц измерения ||" }, "sort": { "type": "integer", "description": "| Порядок позиции в списке." } }, "required": [ "fields", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями товарной позиции в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, в который добавляется позиция. Тип элемента задает имя метода: `crm.deal.productrow.add` добавляет позицию в сделку." }, "productId": { "type": "integer", "description": "| Идентификатор товара из каталога. Если не передать `productName`, название позиции берется из каталога." }, "productName": { "type": "string", "description": "| Название позиции. Для позиции без товара из каталога передайте название явно ||" }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом скидки и налога ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество ||" }, "discountTypeId": { "type": "integer", "description": "| Тип скидки." }, "discountRate": { "type": "number", "format": "double", "description": "| Скидка в процентах. Используйте, если `discountTypeId` равно `2` ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Сумма скидки на единицу товара. Используйте, если `discountTypeId` равно `1`. При скидке в процентах сумма рассчитывается автоматически ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Ставка налога в процентах, например `20`. Без значения позиция считается без налога." }, "taxIncluded": { "type": "boolean", "description": "| Включен ли налог в цену." }, "measureCode": { "type": "integer", "description": "| Код единицы измерения по классификатору, например `796` — штука. Название единицы в `measureName` подставляется по коду." }, "measureName": { "type": "string", "description": "| Название единицы измерения. Если передан `measureCode`, название берется из справочника единиц измерения ||" }, "sort": { "type": "integer", "description": "| Порядок позиции в списке." } }, "required": [ "fields", "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.delete": { "post": { "summary": "Удалить товарную позицию v 3.0 crm.<тип>.productrow.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.get": { "post": { "summary": "Получить товарную позицию v 3.0 crm.<тип>.productrow.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть, например `[\"id\",\"productName\",\"price\"]`. Доступные поля описаны в обзоре методов товарных позиций. Связанных объектов у позиции нет, путь через точку не поддерживается." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть, например `[\"id\",\"productName\",\"price\"]`. Доступные поля описаны в обзоре методов товарных позиций. Связанных объектов у позиции нет, путь через точку не поддерживается." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.getavailableforpayment": { "post": { "summary": "Получить неоплаченные товарные позиции элемента v 3.0 crm.<тип>.productrow.getavailableforpayment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_getavailableforpayment", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-get-available-for-payment-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у каждой позиции, например `[\"id\",\"productName\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у каждой позиции, например `[\"id\",\"productName\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "ownerId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.list": { "post": { "summary": "Получить список товарных позиций элемента v 3.0 crm.<тип>.productrow.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по `ownerId` обязательно, например `[[\"ownerId\",\"=\",37]]`. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть, например `[\"id\",\"productName\",\"price\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `sort` и `id`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество позиций на странице. Значения больше `1000` уменьшаются до `1000`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество позиций, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0: массив условий вида `[\"поле\", \"оператор\", \"значение\"]`. Условие по `ownerId` обязательно, например `[[\"ownerId\",\"=\",37]]`. Описание параметра ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть, например `[\"id\",\"productName\",\"price\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по полям `sort` и `id`." }, "pagination": { "type": "object", "description": "| Объект постраничной навигации. Описание параметра ||" }, "limit": { "type": "integer", "description": "| Количество позиций на странице. Значения больше `1000` уменьшаются до `1000`. Ноль и отрицательное значение вызывают ошибку." }, "page": { "type": "integer", "description": "| Номер страницы, начиная с `1`. Если передан `page`, параметр `offset` не учитывается ||" }, "offset": { "type": "integer", "description": "| Количество позиций, которые нужно пропустить от начала списка." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.replace": { "post": { "summary": "Заменить все товарные позиции элемента v 3.0 crm.<тип>.productrow.replace", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_replace", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-replace-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, позиции которого заменяются." }, "items": { "type": "string", "description": "| Новый набор позиций. Каждая позиция — объект с полями в формате `{\"поле\": \"значение\"}`, в позиции должно быть хотя бы одно поле. Описание параметра" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у каждой позиции в ответе, например `[\"id\",\"productName\",\"price\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "ownerId", "items" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Идентификатор элемента CRM, позиции которого заменяются." }, "items": { "type": "string", "description": "| Новый набор позиций. Каждая позиция — объект с полями в формате `{\"поле\": \"значение\"}`, в позиции должно быть хотя бы одно поле. Описание параметра" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть у каждой позиции в ответе, например `[\"id\",\"productName\",\"price\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "ownerId", "items" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/productrow.update": { "post": { "summary": "Изменить товарную позицию v 3.0 crm.<тип>.productrow.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "productrow_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/product-rows/crm-entity-product-row-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Передайте хотя бы одно поле." }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть в ответе, например `[\"id\",\"price\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор товарной позиции." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Передайте хотя бы одно поле." }, "select": { "type": "array", "items": {}, "description": "| Список полей позиции, которые нужно вернуть в ответе, например `[\"id\",\"price\",\"quantity\"]`. Доступные поля описаны в обзоре методов товарных позиций." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.add": { "post": { "summary": "Добавить реквизит v 3.0 crm.<тип>.requisite.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями реквизита в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "companyId": { "type": "string", "description": "или contactId*" }, "presetId": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Шаблон определяет, какие поля можно заполнить: организация, ИП, физическое лицо и другие." }, "active": { "type": "boolean", "description": "| Активен ли реквизит." }, "sort": { "type": "integer", "description": "| Сортировка." }, "xmlId": { "type": "string", "description": "| Внешний код реквизита ||" }, "originatorId": { "type": "string", "description": "| Идентификатор внешнего источника данных ||" } }, "required": [ "fields", "presetId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями реквизита в формате `{\"поле\": \"значение\"}`. Описание параметра" }, "companyId": { "type": "string", "description": "или contactId*" }, "presetId": { "type": "integer", "description": "| Идентификатор шаблона реквизита. Шаблон определяет, какие поля можно заполнить: организация, ИП, физическое лицо и другие." }, "active": { "type": "boolean", "description": "| Активен ли реквизит." }, "sort": { "type": "integer", "description": "| Сортировка." }, "xmlId": { "type": "string", "description": "| Внешний код реквизита ||" }, "originatorId": { "type": "string", "description": "| Идентификатор внешнего источника данных ||" } }, "required": [ "fields", "presetId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.address.add": { "post": { "summary": "Добавить адрес реквизита v 3.0 crm.<тип>.requisite.address.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_address_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-address-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями адреса. Обязательные поля — `requisiteId` и `typeId`, и хотя бы одно поле адреса должно быть заполнено." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями адреса. Обязательные поля — `requisiteId` и `typeId`, и хотя бы одно поле адреса должно быть заполнено." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.address.delete": { "post": { "summary": "Удалить адрес реквизита v 3.0 crm.<тип>.requisite.address.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_address_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-address-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" } }, "required": [ "requisiteId", "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" } }, "required": [ "requisiteId", "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.address.get": { "post": { "summary": "Получить адрес реквизита v 3.0 crm.<тип>.requisite.address.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_address_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-address-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей адреса, которые нужно вернуть, например `[\"city\",\"postalCode\"]`. Описание полей." } }, "required": [ "requisiteId", "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей адреса, которые нужно вернуть, например `[\"city\",\"postalCode\"]`. Описание полей." } }, "required": [ "requisiteId", "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.address.list": { "post": { "summary": "Получить адреса реквизита v 3.0 crm.<тип>.requisite.address.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_address_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-address-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0. Обязательно условие `[\"requisiteId\",\"=\",<идентификатор>]`. Дополнительно можно фильтровать по `typeId` и полям адреса, в том числе группами условий с `\"type\": \"filter\"` и `\"logic\": \"or\"`. Синтаксис — в обзоре REST 3.0 ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей адреса, которые нужно вернуть. Описание полей." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `typeId` и полям адреса." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество адресов на странице, от `1` до `1000`, по умолчанию `50`, `offset` — сколько адресов пропустить. Значение `limit` больше `1000` вызывает ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр в формате REST 3.0. Обязательно условие `[\"requisiteId\",\"=\",<идентификатор>]`. Дополнительно можно фильтровать по `typeId` и полям адреса, в том числе группами условий с `\"type\": \"filter\"` и `\"logic\": \"or\"`. Синтаксис — в обзоре REST 3.0 ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей адреса, которые нужно вернуть. Описание полей." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `typeId` и полям адреса." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество адресов на странице, от `1` до `1000`, по умолчанию `50`, `offset` — сколько адресов пропустить. Значение `limit` больше `1000` вызывает ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.address.update": { "post": { "summary": "Изменить адрес реквизита v 3.0 crm.<тип>.requisite.address.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_address_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-address-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей адреса. Передайте хотя бы одно поле. Поля адреса: `address1` — улица и дом, `address2` — квартира или офис, `city`, `postalCode`, `region` — район, `province` — область, `country`, `countryCode`. Код страны `countryCode` сохраняется, только если совпадает с назв..." } }, "required": [ "requisiteId", "typeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита." }, "typeId": { "type": "integer", "description": "| Тип адреса, например `1` — фактический, `6` — юридический. Список типов — в обзоре методов реквизитов ||" }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей адреса. Передайте хотя бы одно поле. Поля адреса: `address1` — улица и дом, `address2` — квартира или офис, `city`, `postalCode`, `region` — район, `province` — область, `country`, `countryCode`. Код страны `countryCode` сохраняется, только если совпадает с назв..." } }, "required": [ "requisiteId", "typeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.bankrequisite.add": { "post": { "summary": "Добавить банковский реквизит v 3.0 crm.<тип>.requisite.bankrequisite.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_bankrequisite_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-bank-requisite-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями банковского реквизита. Описание параметра" }, "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита, к которому добавляется банковский реквизит. Изменить его после создания нельзя." } }, "required": [ "fields", "requisiteId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями банковского реквизита. Описание параметра" }, "requisiteId": { "type": "integer", "description": "| Идентификатор реквизита, к которому добавляется банковский реквизит. Изменить его после создания нельзя." } }, "required": [ "fields", "requisiteId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.bankrequisite.delete": { "post": { "summary": "Удалить банковский реквизит v 3.0 crm.<тип>.requisite.bankrequisite.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_bankrequisite_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-bank-requisite-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.bankrequisite.get": { "post": { "summary": "Получить банковский реквизит v 3.0 crm.<тип>.requisite.bankrequisite.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_bankrequisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-bank-requisite-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть, например `[\"id\",\"name\",\"bik\"]`. Описание полей." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть, например `[\"id\",\"name\",\"bik\"]`. Описание полей." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.bankrequisite.list": { "post": { "summary": "Получить банковские реквизиты реквизита v 3.0 crm.<тип>.requisite.bankrequisite.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_bankrequisite_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-bank-requisite-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по реквизиту: `[\"requisiteId\",\"=\",<идентификатор>]`. Оператор — только `=`, значение — положительное целое число ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей банковского реквизита, которые нужно вернуть. Описание полей. Поля `companyId` и `contactId` в `select` недоступны." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `id`, `name` и банковским полям, кроме `requisiteId`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество записей на странице, `offset` — сколько записей пропустить. Ноль и отрицательные значения вызывают ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условие по реквизиту: `[\"requisiteId\",\"=\",<идентификатор>]`. Оператор — только `=`, значение — положительное целое число ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей банковского реквизита, которые нужно вернуть. Описание полей. Поля `companyId` и `contactId` в `select` недоступны." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `id`, `name` и банковским полям, кроме `requisiteId`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество записей на странице, `offset` — сколько записей пропустить. Ноль и отрицательные значения вызывают ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.bankrequisite.update": { "post": { "summary": "Изменить банковский реквизит v 3.0 crm.<тип>.requisite.bankrequisite.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_bankrequisite_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-bank-requisite-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей. Передайте хотя бы одно поле." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор банковского реквизита." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей. Передайте хотя бы одно поле." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.delete": { "post": { "summary": "Удалить реквизит v 3.0 crm.<тип>.requisite.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.get": { "post": { "summary": "Получить реквизит v 3.0 crm.<тип>.requisite.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." }, "select": { "type": "array", "items": {}, "description": "| Список полей реквизита, которые нужно вернуть, например `[\"id\",\"name\",\"inn\"]`. Доступные поля описаны в обзоре методов реквизитов." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." }, "select": { "type": "array", "items": {}, "description": "| Список полей реквизита, которые нужно вернуть, например `[\"id\",\"name\",\"inn\"]`. Доступные поля описаны в обзоре методов реквизитов." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.list": { "post": { "summary": "Получить список реквизитов контакта или компании v 3.0 crm.<тип>.requisite.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр с одним условием по владельцу: `[[\"companyId\",\"=\",3167]]` в методе компании, `[[\"contactId\",\"=\",14]]` в методе контакта. Других полей для фильтра нет, оператор — только `=`, без групп и отрицания ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей реквизита, которые нужно вернуть. Поля и вложенные объекты `addresses`, `bankRequisites` — как в select метода crm.<тип>.requisite.get." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно только по `id`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество реквизитов на странице, по умолчанию `50`, `offset` — сколько реквизитов пропустить. Ноль и отрицательный `limit` вызывают ошибку ||" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр с одним условием по владельцу: `[[\"companyId\",\"=\",3167]]` в методе компании, `[[\"contactId\",\"=\",14]]` в методе контакта. Других полей для фильтра нет, оператор — только `=`, без групп и отрицания ||" }, "select": { "type": "array", "items": {}, "description": "| Список полей реквизита, которые нужно вернуть. Поля и вложенные объекты `addresses`, `bankRequisites` — как в select метода crm.<тип>.requisite.get." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно только по `id`." }, "pagination": { "type": "object", "description": "| Постраничная навигация: `limit` — количество реквизитов на странице, по умолчанию `50`, `offset` — сколько реквизитов пропустить. Ноль и отрицательный `limit` вызывают ошибку ||" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.preset.get": { "post": { "summary": "Получить шаблон реквизита v 3.0 crm.<тип>.requisite.preset.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_preset_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-preset-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор шаблона." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.preset.list": { "post": { "summary": "Получить список шаблонов реквизитов v 3.0 crm.<тип>.requisite.preset.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_preset_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-preset-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `sort` и `id`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Сортировать можно по `sort` и `id`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/requisite.update": { "post": { "summary": "Изменить реквизит v 3.0 crm.<тип>.requisite.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../../rest-v3.md).", "operationId": "requisite_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/rest-v3/requisites/crm-entity-requisite-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Поля описаны в параметре fields метода crm.<тип>.requisite.add." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор реквизита." }, "fields": { "type": "object", "description": "| Объект с новыми значениями полей в формате `{\"поле\": \"значение\"}`. Поля описаны в параметре fields метода crm.<тип>.requisite.add." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/rpa.comment.add": { "post": { "summary": "Создать новый комментарий в таймлайне rpa.comment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_comment_add", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/comment/rpa-comment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект, описывающий поля комментария ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML и BB-code форматирование ||" }, "files": { "type": "array", "items": {}, "description": "| Массив прикрепленных файлов. Каждый элемент — это массив с именем и содержимым, закодированным в base64 ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект, описывающий поля комментария ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML и BB-code форматирование ||" }, "files": { "type": "array", "items": {}, "description": "| Массив прикрепленных файлов. Каждый элемент — это массив с именем и содержимым, закодированным в base64 ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.comment.delete": { "post": { "summary": "Удалить комментарий rpa.comment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_comment_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/comment/rpa-comment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.comment.update": { "post": { "summary": "Изменить запись таймлайна rpa.comment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_comment_update", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/comment/rpa-comment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор комментария ||" }, "fields": { "type": "object", "description": "| Объект, описывающий поля комментария ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор комментария ||" }, "fields": { "type": "object", "description": "| Объект, описывающий поля комментария ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.getSettings": { "post": { "summary": "Получить полный набор настроек видимости полей rpa.fields.getSettings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_fields_getSettings", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/fields/rpa-fields-get-settings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.setSettings": { "post": { "summary": "Установить полный набора настроек видимости полей rpa.fields.setSettings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_fields_setSettings", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/fields/rpa-fields-set-settings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." }, "fields": { "type": "object", "description": "| Массив с настройками видимости полей." } }, "required": [ "typeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." }, "fields": { "type": "object", "description": "| Массив с настройками видимости полей." } }, "required": [ "typeId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.setVisibilitySettings": { "post": { "summary": "Изменить настройки видимости полей rpa.fields.setVisibilitySettings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_fields_setVisibilitySettings", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/fields/rpa-fields-set-visibility-settings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "visibility": { "type": "string", "description": "| Идентификатор видимости, для которого меняются настройки ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." }, "fields": { "type": "array", "items": {}, "description": "| Массив с полями, для которых необходимо поменять настройку ||" } }, "required": [ "typeId", "visibility", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "visibility": { "type": "string", "description": "| Идентификатор видимости, для которого меняются настройки ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии." }, "fields": { "type": "array", "items": {}, "description": "| Массив с полями, для которых необходимо поменять настройку ||" } }, "required": [ "typeId", "visibility", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.add": { "post": { "summary": "Добавить элемент процесса rpa.item.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_add", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения пользовательских полей элемента. Все остальные поля будут проигнорированы ||" } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "fields": { "type": "array", "items": {}, "description": "| Значения пользовательских полей элемента. Все остальные поля будут проигнорированы ||" } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.delete": { "post": { "summary": "Удалить элемент rpa.item.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" } }, "required": [ "typeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" } }, "required": [ "typeId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.get": { "post": { "summary": "Получить информацию об элементе rpa.item.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_get", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" }, "stageId": { "type": "string", "description": "| Идентификатор стадии, на которой находится элемент ||" }, "previousStageId": { "type": "string", "description": "| Идентификатор предыдущей стадии элемента ||" }, "createdBy": { "type": "string", "description": "| Идентификатор пользователя, создавшего элемент ||" }, "updatedBy": { "type": "string", "description": "| Идентификатор пользователя, изменившего элемент ||" }, "movedBy": { "type": "string", "description": "| Идентификатор пользователя, изменившего стадию элемента ||" }, "createdTime": { "type": "string", "description": "| Время создания элемента ||" }, "updatedTime": { "type": "string", "description": "| Время изменения элемента ||" }, "movedTime": { "type": "string", "description": "| Время изменения стадии элемента ||" }, "detailUrl": { "type": "string", "description": "| Ссылка на карточку элемента ||" }, "tasksCounter": { "type": "string", "description": "| Количество заданий на элементе для пользователя ||" }, "tasksFaces": { "type": "string", "description": "| Информация для отрисовки последовательности ответственных при утверждении:" }, "permissions": { "type": "string", "description": "| Права текущего пользователя на элемент:" }, "users": { "type": "string", "description": "| Агрегированная информация о всех пользователях, имеющих отношение к элементу. Список, где ключ — идентификатор пользователя:" }, "UF_RPA_...": { "type": "string", "description": "| Значения пользовательских полей." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" }, "stageId": { "type": "string", "description": "| Идентификатор стадии, на которой находится элемент ||" }, "previousStageId": { "type": "string", "description": "| Идентификатор предыдущей стадии элемента ||" }, "createdBy": { "type": "string", "description": "| Идентификатор пользователя, создавшего элемент ||" }, "updatedBy": { "type": "string", "description": "| Идентификатор пользователя, изменившего элемент ||" }, "movedBy": { "type": "string", "description": "| Идентификатор пользователя, изменившего стадию элемента ||" }, "createdTime": { "type": "string", "description": "| Время создания элемента ||" }, "updatedTime": { "type": "string", "description": "| Время изменения элемента ||" }, "movedTime": { "type": "string", "description": "| Время изменения стадии элемента ||" }, "detailUrl": { "type": "string", "description": "| Ссылка на карточку элемента ||" }, "tasksCounter": { "type": "string", "description": "| Количество заданий на элементе для пользователя ||" }, "tasksFaces": { "type": "string", "description": "| Информация для отрисовки последовательности ответственных при утверждении:" }, "permissions": { "type": "string", "description": "| Права текущего пользователя на элемент:" }, "users": { "type": "string", "description": "| Агрегированная информация о всех пользователях, имеющих отношение к элементу. Список, где ключ — идентификатор пользователя:" }, "UF_RPA_...": { "type": "string", "description": "| Значения пользовательских полей." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.getTasks": { "post": { "summary": "Получить данные о текущих заданиях элемента rpa.item.getTasks", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_getTasks", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-get-tasks.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.list": { "post": { "summary": "Получить массив элементов процесса rpa.item.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_list", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации." }, "start": { "type": "integer", "description": "| Сдвиг для постраничной навигации. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации." }, "start": { "type": "integer", "description": "| Сдвиг для постраничной навигации. ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.update": { "post": { "summary": "Изменить элемент процессса rpa.item.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_item_update", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/item/rpa-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект со значениями пользовательских полей элемента ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "id": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект со значениями пользовательских полей элемента ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.add": { "post": { "summary": "Создать новую стадию rpa.stage.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_stage_add", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/stage/rpa-stage-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями стадии ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями стадии ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.delete": { "post": { "summary": "Удалить стадию rpa.stage.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_stage_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/stage/rpa-stage-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.get": { "post": { "summary": "Получить информацию о стадии rpa.stage.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_stage_get", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/stage/rpa-stage-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.listForType": { "post": { "summary": "Получить список стадий процесса rpa.stage.listForType", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_stage_listForType", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/stage/rpa-stage-list-for-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.update": { "post": { "summary": "Обновить стадию rpa.stage.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_stage_update", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/stage/rpa-stage-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" }, "fields": { "type": "array", "items": {}, "description": "| Объект с полями стадии ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" }, "fields": { "type": "array", "items": {}, "description": "| Объект с полями стадии ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.addUser": { "post": { "summary": "Добавить пользователя к существующему заданию rpa.task.addUser", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_task_addUser", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/task/rpa-task-add-user.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии ||" }, "robotName": { "type": "string", "description": "| Имя робота ||" }, "userValue": { "type": "string", "description": "| Строка с пользователем формата `Имя Фамилия [ид пользователя]` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии ||" }, "robotName": { "type": "string", "description": "| Имя робота ||" }, "userValue": { "type": "string", "description": "| Строка с пользователем формата `Имя Фамилия [ид пользователя]` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.delete": { "post": { "summary": "Удалить робота из процесса rpa.task.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_task_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/task/rpa-task-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии ||" }, "robotName": { "type": "string", "description": "| Имя робота ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии ||" }, "robotName": { "type": "string", "description": "| Имя робота ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.do": { "post": { "summary": "Выполненить задание rpa.task.do", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_task_do", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/task/rpa-task-do.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.add": { "post": { "summary": "Добавить новую запись таймлайна rpa.timeline.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_timeline_add", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/timeline/rpa-timeline-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект с полями записи ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML теги ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "fields": { "type": "object", "description": "| Объект с полями записи ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML теги ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.delete": { "post": { "summary": "Удалить запись таймлайна rpa.timeline.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_timeline_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/timeline/rpa-timeline-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.listForItem": { "post": { "summary": "Получить список записей таймлайна для элемента rpa.timeline.listForItem", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_timeline_listForItem", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/timeline/rpa-timeline-list-for-item.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Идентификатор процесса ||" }, "itemId": { "type": "integer", "description": "| Идентификатор элемента ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.update": { "post": { "summary": "Обновить запись таймлайна rpa.timeline.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_timeline_update", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/timeline/rpa-timeline-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" }, "fields": { "type": "object", "description": "| Объект с полями записи ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML теги ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" }, "fields": { "type": "object", "description": "| Объект с полями записи ||" }, "title": { "type": "string", "description": "| Заголовок записи ||" }, "description": { "type": "string", "description": "| Описание записи. Можно использовать HTML теги ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.updateIsFixed": { "post": { "summary": "Обновить флаг прикрепления записи rpa.timeline.updateIsFixed", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_timeline_updateIsFixed", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/timeline/rpa-timeline-update-is-fixed.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" }, "isFixed": { "type": "string", "description": "| Флаг прикрепления записи. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор записи ||" }, "isFixed": { "type": "string", "description": "| Флаг прикрепления записи. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.add": { "post": { "summary": "Создать процесс rpa.type.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_type_add", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/type/rpa-type-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Список с полями процесса. Перечень возможных полей описан ниже ||" }, "title": { "type": "string", "description": "| Название процесса ||" }, "image": { "type": "string", "description": "| Изображение процесса из списка ||" }, "settings": { "type": "array", "items": {}, "description": "| Список с произвольным набором настроек процесса ||" }, "permissions": { "type": "array", "items": {}, "description": "| Список объектов. Каждый объект описывает права доступа к этому процессу ||" } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Список с полями процесса. Перечень возможных полей описан ниже ||" }, "title": { "type": "string", "description": "| Название процесса ||" }, "image": { "type": "string", "description": "| Изображение процесса из списка ||" }, "settings": { "type": "array", "items": {}, "description": "| Список с произвольным набором настроек процесса ||" }, "permissions": { "type": "array", "items": {}, "description": "| Список объектов. Каждый объект описывает права доступа к этому процессу ||" } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.delete": { "post": { "summary": "Удалить процесс rpa.type.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_type_delete", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/type/rpa-type-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.get": { "post": { "summary": "Получить информацию о процессе по id rpa.type.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_type_get", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/type/rpa-type-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.list": { "post": { "summary": "Получить список процессов с их полями rpa.type.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_type_list", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/type/rpa-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей для вывода. По умолчанию выводятся все ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей для вывода. По умолчанию выводятся все ||" }, "order": { "type": "object", "description": "| Список для сортировки, где ключ — поле, а значение — `ASC` или `DESC` ||" }, "filter": { "type": "object", "description": "| Список для фильтрации ||" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.update": { "post": { "summary": "Обновить процесс rpa.type.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [смарт-процессы](../../../crm/universal/user-defined-object-types/index.md) как аналог функционала.", "operationId": "rpa_type_update", "tags": [ "Устаревшие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/outdated/rpa/type/rpa-type-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" }, "fields": { "type": "array", "items": {}, "description": "| Список с полями процесса. Полностью аналогичен набору из метода rpa.type.add ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор процесса ||" }, "fields": { "type": "array", "items": {}, "description": "| Список с полями процесса. Полностью аналогичен набору из метода rpa.type.add ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/sale.basketitem.add": { "post": { "summary": "Добавить произвольную позицию в корзину заказа sale.basketitem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.add` добавляет позицию в корзину существующего заказа.", "operationId": "sale_basketitem_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей позиции корзины (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа. По умолчанию `100` ||" }, "productId": { "type": "string", "description": "| Идентификатор товара или вариации из каталога." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом наценок и скидок." }, "basePrice": { "type": "number", "format": "double", "description": "| Исходная цена без учета наценок и скидок. Для товара из каталога по умолчанию берется из каталога. У произвольной позиции без `basePrice` поле равно `0`, даже если передан `price` ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Величина итоговой скидки или наценки. Если передаете `price`, `basePrice` и `discountPrice` сами, соблюдайте условие `basePrice = price + discountPrice` ||" }, "currency": { "type": "string", "description": "| Валюта цены. Должна совпадать с валютой заказа, иначе метод вернет ошибку `200140400011`. Валюту заказа возвращает метод sale.order.get ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины. Если не передать, Битрикс24 создаст код вида `bx_6ab9ff3cc2d0a` ||" } }, "required": [ "fields", "orderId", "productId", "currency", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей позиции корзины (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа. По умолчанию `100` ||" }, "productId": { "type": "string", "description": "| Идентификатор товара или вариации из каталога." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом наценок и скидок." }, "basePrice": { "type": "number", "format": "double", "description": "| Исходная цена без учета наценок и скидок. Для товара из каталога по умолчанию берется из каталога. У произвольной позиции без `basePrice` поле равно `0`, даже если передан `price` ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Величина итоговой скидки или наценки. Если передаете `price`, `basePrice` и `discountPrice` сами, соблюдайте условие `basePrice = price + discountPrice` ||" }, "currency": { "type": "string", "description": "| Валюта цены. Должна совпадать с валютой заказа, иначе метод вернет ошибку `200140400011`. Валюту заказа возвращает метод sale.order.get ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины. Если не передать, Битрикс24 создаст код вида `bx_6ab9ff3cc2d0a` ||" } }, "required": [ "fields", "orderId", "productId", "currency", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.addCatalogProduct": { "post": { "summary": "Добавить позицию с товаром из каталога в корзину заказа sale.basketitem.addCatalogProduct", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.addCatalogProduct` добавляет позицию с товаром или услугой из модуля catalog в корзину существующего заказа.", "operationId": "sale_basketitem_addCatalogProduct", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-add-catalog-product.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания позиции корзины в заказе (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа. Изменить его после создания позиции нельзя." }, "productId": { "type": "string", "description": "| Идентификатор товара, услуги или вариации из каталога. Изменить его после создания позиции нельзя." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара. Передавайте значение больше `0`: при `0` метод создаст позицию без цены и названия. Можно передать дробное число, например `1.5` ||" }, "currency": { "type": "string", "description": "| Валюта цены, например `RUB`. Должна совпадать с валютой заказа, иначе метод вернет ошибку `200140400011`. Изменить ее после создания позиции нельзя ||" }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом скидок и наценок." }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа. По умолчанию `100` ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины. Если не передан, Битрикс24 создаст код сам, например `bx_662675fba6516` ||" } }, "required": [ "fields", "orderId", "productId", "quantity", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания позиции корзины в заказе (подробное описание) ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа. Изменить его после создания позиции нельзя." }, "productId": { "type": "string", "description": "| Идентификатор товара, услуги или вариации из каталога. Изменить его после создания позиции нельзя." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара. Передавайте значение больше `0`: при `0` метод создаст позицию без цены и названия. Можно передать дробное число, например `1.5` ||" }, "currency": { "type": "string", "description": "| Валюта цены, например `RUB`. Должна совпадать с валютой заказа, иначе метод вернет ошибку `200140400011`. Изменить ее после создания позиции нельзя ||" }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу с учетом скидок и наценок." }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа. По умолчанию `100` ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины. Если не передан, Битрикс24 создаст код сам, например `bx_662675fba6516` ||" } }, "required": [ "fields", "orderId", "productId", "quantity", "currency" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.delete": { "post": { "summary": "Удалить позицию из корзины заказа sale.basketitem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.delete` удаляет позицию корзины из заказа. После удаления сумма заказа пересчитывается. Если удалить последнюю позицию, заказ остается без позиций с суммой `0`.", "operationId": "sale_basketitem_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.get": { "post": { "summary": "Получить позицию корзины sale.basketitem.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.get` получает информацию о позиции корзины заказа по ее идентификатору.", "operationId": "sale_basketitem_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.getFields": { "post": { "summary": "Получить поля позиции корзины sale.basketitem.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.getFields` возвращает список доступных полей позиции корзины. Каждое поле описывается в виде структуры настроек поля [rest_field_description](../data-types.md).", "operationId": "sale_basketitem_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.getFieldsCatalogProduct": { "post": { "summary": "Получить поля позиции с товаром из каталога sale.basketitem.getFieldsCatalogProduct", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.getFieldsCatalogProduct` возвращает список полей позиции корзины для методов [sale.basketitem.addCatalogProduct](./sale-basket-item-add-catalog-product.md) и [sale.basketitem.updateCatalogProduct](./sale-basket-item-update-catalog-product.md) — эти методы работают только с товарами модуля catalog.", "operationId": "sale_basketitem_getFieldsCatalogProduct", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.list": { "post": { "summary": "Получить список позиций корзины sale.basketitem.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.list` возвращает список позиций корзины, отобранных по фильтру.", "operationId": "sale_basketitem_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных записей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.update": { "post": { "summary": "Изменить позицию корзины заказа sale.basketitem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.update` изменяет позицию корзины существующего заказа. После изменения количества или цены Битрикс24 пересчитывает сумму заказа.", "operationId": "sale_basketitem_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины. Получить идентификаторы позиций можно методом sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Значения изменяемых полей (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара. Передавайте в каждом вызове, даже если количество не меняется, иначе метод вернет ошибку `Required fields: quantity`." }, "sort": { "type": "integer", "description": "| Положение в списке позиций корзины ||" }, "price": { "type": "number", "format": "double", "description": "| Цена с учетом наценок и скидок. Если передать цену, Битрикс24 установит позиции `customPrice` = `Y` — цена считается указанной вручную и больше не берется из каталога ||" }, "basePrice": { "type": "number", "format": "double", "description": "| Исходная цена без учета наценок и скидок. Передавайте вместе с `price` и `discountPrice` так, чтобы выполнялось условие `basePrice = price + discountPrice` ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Величина итоговой скидки или наценки. Для наценки значение отрицательное ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины ||" }, "weight": { "type": "number", "format": "double", "description": "| Вес товара. Позиция из каталога получает значение поля `weight` товара без пересчета, поэтому передавайте вес в тех же единицах, что в каталоге ||" }, "dimensions": { "type": "string", "description": "| Размеры товара — строка с PHP-сериализованным массивом с ключами `WIDTH`, `HEIGHT` и `LENGTH`, например `a:3:{s:5:\"WIDTH\";i:244;s:6:\"HEIGHT\";i:100;s:6:\"LENGTH\";i:31;}`. В таком виде размеры хранятся у позиций, добавленных из каталога." }, "measureCode": { "type": "string", "description": "| Код единицы измерения товара ||" }, "measureName": { "type": "string", "description": "| Название единицы измерения ||" }, "canBuy": { "type": "string", "description": "| Флаг доступности товара. Возможные значения:" }, "vatRate": { "type": "number", "format": "double", "description": "| Ставка налога долей от единицы: `0.1` — это 10 %. Для ставки «Без НДС» передайте пустую строку, в ответе будет `null` ||" }, "vatIncluded": { "type": "string", "description": "| Флаг того, включен ли НДС или налог в цену товара. Возможные значения:" } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины. Получить идентификаторы позиций можно методом sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Значения изменяемых полей (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара. Передавайте в каждом вызове, даже если количество не меняется, иначе метод вернет ошибку `Required fields: quantity`." }, "sort": { "type": "integer", "description": "| Положение в списке позиций корзины ||" }, "price": { "type": "number", "format": "double", "description": "| Цена с учетом наценок и скидок. Если передать цену, Битрикс24 установит позиции `customPrice` = `Y` — цена считается указанной вручную и больше не берется из каталога ||" }, "basePrice": { "type": "number", "format": "double", "description": "| Исходная цена без учета наценок и скидок. Передавайте вместе с `price` и `discountPrice` так, чтобы выполнялось условие `basePrice = price + discountPrice` ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Величина итоговой скидки или наценки. Для наценки значение отрицательное ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины ||" }, "weight": { "type": "number", "format": "double", "description": "| Вес товара. Позиция из каталога получает значение поля `weight` товара без пересчета, поэтому передавайте вес в тех же единицах, что в каталоге ||" }, "dimensions": { "type": "string", "description": "| Размеры товара — строка с PHP-сериализованным массивом с ключами `WIDTH`, `HEIGHT` и `LENGTH`, например `a:3:{s:5:\"WIDTH\";i:244;s:6:\"HEIGHT\";i:100;s:6:\"LENGTH\";i:31;}`. В таком виде размеры хранятся у позиций, добавленных из каталога." }, "measureCode": { "type": "string", "description": "| Код единицы измерения товара ||" }, "measureName": { "type": "string", "description": "| Название единицы измерения ||" }, "canBuy": { "type": "string", "description": "| Флаг доступности товара. Возможные значения:" }, "vatRate": { "type": "number", "format": "double", "description": "| Ставка налога долей от единицы: `0.1` — это 10 %. Для ставки «Без НДС» передайте пустую строку, в ответе будет `null` ||" }, "vatIncluded": { "type": "string", "description": "| Флаг того, включен ли НДС или налог в цену товара. Возможные значения:" } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.updateCatalogProduct": { "post": { "summary": "Изменить позицию с товаром из каталога sale.basketitem.updateCatalogProduct", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketitem.updateCatalogProduct` изменяет позицию корзины с товаром из каталога в существующем заказе.", "operationId": "sale_basketitem_updateCatalogProduct", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-item/sale-basket-item-update-catalog-product.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины. Получить его можно методами sale.basketitem.addCatalogProduct и sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Объект с изменяемыми полями (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара, например `4` или `1.5`. Передавайте всегда, даже если меняете только другие поля: без него метод вернет ошибку `Required fields: quantity`." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товара. Если не передать, остается текущая цена позиции ||" }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины ||" } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор позиции корзины. Получить его можно методами sale.basketitem.addCatalogProduct и sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Объект с изменяемыми полями (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара, например `4` или `1.5`. Передавайте всегда, даже если меняете только другие поля: без него метод вернет ошибку `Required fields: quantity`." }, "price": { "type": "number", "format": "double", "description": "| Цена за единицу товара. Если не передать, остается текущая цена позиции ||" }, "sort": { "type": "integer", "description": "| Положение в списке позиций заказа ||" }, "xmlId": { "type": "string", "description": "| Внешний код позиции корзины ||" } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.add": { "post": { "summary": "Создать свойство элемента корзины sale.basketproperties.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.add` добавляет свойство для элемента корзины в заказе.", "operationId": "sale_basketproperties_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания свойства элемента (позиции) корзины:" }, "basketId": { "type": "string", "description": "| Идентификатор элемента (позиции) корзины заказа. Позиция должна входить в заказ: у нее заполнено поле `orderId`." }, "value": { "type": "string", "description": "| Значение свойства ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Битрикс24 не проверяет уникальность кода: повторный вызов с тем же `code` создаст у позиции второе свойство ||" }, "sort": { "type": "integer", "description": "| Положение в списке свойств." }, "xmlId": { "type": "string", "description": "| Внешний код свойства." } }, "required": [ "fields", "basketId", "value", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания свойства элемента (позиции) корзины:" }, "basketId": { "type": "string", "description": "| Идентификатор элемента (позиции) корзины заказа. Позиция должна входить в заказ: у нее заполнено поле `orderId`." }, "value": { "type": "string", "description": "| Значение свойства ||" }, "code": { "type": "string", "description": "| Символьный код свойства. Битрикс24 не проверяет уникальность кода: повторный вызов с тем же `code` создаст у позиции второе свойство ||" }, "sort": { "type": "integer", "description": "| Положение в списке свойств." }, "xmlId": { "type": "string", "description": "| Внешний код свойства." } }, "required": [ "fields", "basketId", "value", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.delete": { "post": { "summary": "Удалить свойство корзины sale.basketproperties.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.delete` удаляет свойство для элемента корзины в заказе.", "operationId": "sale_basketproperties_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.get": { "post": { "summary": "Получить значение свойства корзины sale.basketproperties.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.get` возвращает свойство для элемента корзины в заказе по его идентификатору.", "operationId": "sale_basketproperties_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.getFields": { "post": { "summary": "Получить поля элементов свойств корзины sale.basketproperties.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.getFields` возвращает описание полей свойства элемента (позиции) корзины. Каждое поле описывается в виде структуры настроек (`rest_field_description`).", "operationId": "sale_basketproperties_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.list": { "post": { "summary": "Получить список свойств корзины sale.basketproperties.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.list` возвращает набор свойств элементов корзины, выбранных по фильтру.", "operationId": "sale_basketproperties_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (см. поля объекта `sale_basket_item_property`)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств корзины в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Если не передать, метод вернет свойства всех позиций корзины." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (см. поля объекта `sale_basket_item_property`)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств корзины в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Если не передать, метод вернет свойства всех позиций корзины." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.update": { "post": { "summary": "Изменить свойство элемента корзины sale.basketproperties.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.basketproperties.update` изменяет свойство для элемента корзины в заказе.", "operationId": "sale_basketproperties_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/basket-properties/sale-basket-properties-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины." }, "fields": { "type": "object", "description": "| Значения изменяемых полей (подробное описание приведено ниже) свойства элемента (позиции) корзины:" }, "value": { "type": "string", "description": "| Значение свойства ||" }, "code": { "type": "string", "description": "| Символьный код свойства ||" }, "sort": { "type": "integer", "description": "| Положение в списке свойств ||" }, "xmlId": { "type": "string", "description": "| Внешний код свойства ||" } }, "required": [ "id", "fields", "value", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства элемента (позиции) корзины." }, "fields": { "type": "object", "description": "| Значения изменяемых полей (подробное описание приведено ниже) свойства элемента (позиции) корзины:" }, "value": { "type": "string", "description": "| Значение свойства ||" }, "code": { "type": "string", "description": "| Символьный код свойства ||" }, "sort": { "type": "integer", "description": "| Положение в списке свойств ||" }, "xmlId": { "type": "string", "description": "| Внешний код свойства ||" } }, "required": [ "id", "fields", "value", "code" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.add": { "post": { "summary": "Добавить соответствие физическому или юридическому лицу sale.businessValuePersonDomain.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.businessValuePersonDomain.add` задает типу плательщика соответствие физическому или юридическому лицу. Без соответствия тип плательщика не участвует в настройках бизнес-смыслов.", "operationId": "sale_businessValuePersonDomain_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового соответствия (подробное описание) ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика." }, "domain": { "type": "string", "description": "| Кто платит по этому типу плательщика:" } }, "required": [ "fields", "personTypeId", "domain" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового соответствия (подробное описание) ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика." }, "domain": { "type": "string", "description": "| Кто платит по этому типу плательщика:" } }, "required": [ "fields", "personTypeId", "domain" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.deleteByFilter": { "post": { "summary": "Удалить соответствие физическому или юридическому лицу sale.businessValuePersonDomain.deleteByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.businessValuePersonDomain.deleteByFilter` удаляет соответствие типа плательщика физическому или юридическому лицу. Метода изменения нет: чтобы сменить домен, удалите соответствие и создайте заново методом [sale.businessValuePersonDomain.add](./sale-business-value-person-domain-add.md).", "operationId": "sale_businessValuePersonDomain_deleteByFilter", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля соответствия, которое нужно удалить (подробное описание) ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика. У каждого типа плательщика только одно соответствие." }, "domain": { "type": "string", "description": "| Домен, который задан у типа плательщика:" } }, "required": [ "fields", "personTypeId", "domain" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля соответствия, которое нужно удалить (подробное описание) ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика. У каждого типа плательщика только одно соответствие." }, "domain": { "type": "string", "description": "| Домен, который задан у типа плательщика:" } }, "required": [ "fields", "personTypeId", "domain" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.getFields": { "post": { "summary": "Получить поля соответствия физическому или юридическому лицу sale.businessValuePersonDomain.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.businessValuePersonDomain.getFields` возвращает описание полей соответствия `personTypeId` и `domain`: тип поля, обязательно ли оно и можно ли его изменить.", "operationId": "sale_businessValuePersonDomain_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.list": { "post": { "summary": "Получить список соответствий физическому или юридическому лицу sale.businessValuePersonDomain.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.businessValuePersonDomain.list` возвращает список соответствий: какие типы плательщиков относятся к физическим лицам — домен `I`, а какие к юридическим — домен `E`. Подробнее — в [обзоре раздела](./index.md).", "operationId": "sale_businessValuePersonDomain_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных соответствий физическому или юридическому лицу в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных соответствий физическому или юридическому лицу в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных соответствий физическому или юридическому лицу в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных соответствий физическому или юридическому лицу в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.cashbox.add": { "post": { "summary": "Добавить кассу sale.cashbox.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.add` добавляет кассу.", "operationId": "sale_cashbox_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре `CODE` ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков ||" }, "OFD": { "type": "string", "description": "| Код обработчика ОФД. Доступные обработчики ОФД:" }, "OFD_SETTINGS": { "type": "object", "description": "| Настройки ОФД (подробное описание приведено ниже)." }, "NUMBER_KKM": { "type": "string", "description": "| Внешний идентификатор кассы." }, "ACTIVE": { "type": "string", "description": "| Активность кассы. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию `100` ||" }, "USE_OFFLINE": { "type": "string", "description": "| Используется ли касса офлайн. Возможные значения:" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки кассы в соответствии со структурой настроек, переданной в ключе `CONFIG` поля `SETTINGS` метода sale.cashbox.handler.add." }, "OFD_MODE": { "type": "object", "description": "| Настройки, относящиеся к режиму работы ОФД. Передается параметр `IS_TEST` (`string` со значениями `Y/N`) — режим работы ОФД:" }, "SELLER_INFO": { "type": "object", "description": "| Настройки раздела «Информация о продавце». Передается обязательный параметр `INN` (`string`) — ИНН продавца" }, "AUTH": { "type": "object", "description": "| Настройки авторизации. Передается параметр `INN` (`string`) — ключ безопасности" } }, "required": [ "REST_CODE", "EMAIL" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре `CODE` ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков ||" }, "OFD": { "type": "string", "description": "| Код обработчика ОФД. Доступные обработчики ОФД:" }, "OFD_SETTINGS": { "type": "object", "description": "| Настройки ОФД (подробное описание приведено ниже)." }, "NUMBER_KKM": { "type": "string", "description": "| Внешний идентификатор кассы." }, "ACTIVE": { "type": "string", "description": "| Активность кассы. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию `100` ||" }, "USE_OFFLINE": { "type": "string", "description": "| Используется ли касса офлайн. Возможные значения:" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Настройки кассы в соответствии со структурой настроек, переданной в ключе `CONFIG` поля `SETTINGS` метода sale.cashbox.handler.add." }, "OFD_MODE": { "type": "object", "description": "| Настройки, относящиеся к режиму работы ОФД. Передается параметр `IS_TEST` (`string` со значениями `Y/N`) — режим работы ОФД:" }, "SELLER_INFO": { "type": "object", "description": "| Настройки раздела «Информация о продавце». Передается обязательный параметр `INN` (`string`) — ИНН продавца" }, "AUTH": { "type": "object", "description": "| Настройки авторизации. Передается параметр `INN` (`string`) — ключ безопасности" } }, "required": [ "REST_CODE", "EMAIL" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.check.apply": { "post": { "summary": "Сохранить результат печати чека sale.cashbox.check.apply", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.check.apply` сохраняет результат печати чека, напечатанного на REST-кассе. UUID чека сохраняется при его печати из ответа `PRINT_URL`, указанного при добавлении обработчика. Пример сценария — в туториале [Как подключить кассу к Битрикс24](../../../tutorials/sale/cashbox-add-example.md).", "operationId": "sale_cashbox_check_apply", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-check-apply.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "UUID": { "type": "string", "description": "| UUID чека ||" }, "PRINT_END_TIME": { "type": "string", "description": "| Время окончания печати чека ||" }, "REG_NUMBER_KKT": { "type": "string", "description": "| Регистрационный номер ККТ ||" }, "FISCAL_DOC_ATTR": { "type": "string", "description": "| Фискальный признак документа ||" }, "FISCAL_DOC_NUMBER": { "type": "string", "description": "| Номер фискального документа ||" }, "FISCAL_RECEIPT_NUMBER": { "type": "string", "description": "| Фискальный номер чека ||" }, "FN_NUMBER": { "type": "string", "description": "| Номер фискального накопителя ||" }, "SHIFT_NUMBER": { "type": "string", "description": "| Номер смены ||" } }, "required": [ "UUID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "UUID": { "type": "string", "description": "| UUID чека ||" }, "PRINT_END_TIME": { "type": "string", "description": "| Время окончания печати чека ||" }, "REG_NUMBER_KKT": { "type": "string", "description": "| Регистрационный номер ККТ ||" }, "FISCAL_DOC_ATTR": { "type": "string", "description": "| Фискальный признак документа ||" }, "FISCAL_DOC_NUMBER": { "type": "string", "description": "| Номер фискального документа ||" }, "FISCAL_RECEIPT_NUMBER": { "type": "string", "description": "| Фискальный номер чека ||" }, "FN_NUMBER": { "type": "string", "description": "| Номер фискального накопителя ||" }, "SHIFT_NUMBER": { "type": "string", "description": "| Номер смены ||" } }, "required": [ "UUID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.delete": { "post": { "summary": "Удалить кассу sale.cashbox.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.delete` удаляет кассу.", "operationId": "sale_cashbox_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор удаляемой кассы ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор удаляемой кассы ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.handler.add": { "post": { "summary": "Добавить обработчик кассы sale.cashbox.handler.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.handler.add` добавляет REST-обработчик кассы.", "operationId": "sale_cashbox_handler_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-handler-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код REST-обработчика. Должен быть уникальным среди всех обработчиков ||" }, "SORT": { "type": "integer", "description": "| Сортировка. Значение по умолчанию: `100` ||" }, "SUPPORTS_FFD105": { "type": "string", "description": "| Поддерживает ли касса формат фискальных данных версии 1.05. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика (подробное описание приведено ниже) ||" }, "PRINT_URL": { "type": "string", "description": "| Адрес, на который отправляются данные для печати чека ||" }, "CHECK_URL": { "type": "string", "description": "| Адрес, по которому происходит проверка статуса чека ||" }, "HTTP_VERSION": { "type": "string", "description": "| Версия протокола HTTP, используемая для запросов. Возможные значения: `1.0`, `1.1`." }, "CONFIG": { "type": "object", "description": "| Структура настроек (подробное описание приведено ниже), которые пользователь сможет устанавливать и изменять на странице редактирования кассы, а также при добавлении или обновлении кассы через REST." }, "LABEL": { "type": "string", "description": "| Заголовок раздела ||" }, "ITEMS": { "type": "object", "description": "| Список настроек раздела (подробное описание приведено ниже)." }, "TYPE": { "type": "string", "description": "| Тип настройки. Возможные значения:" }, "REQUIRED": { "type": "string", "description": "| Является ли настройка обязательной. Возможные значения:" }, "DISABLED": { "type": "string", "description": "| Отключена ли возможность редактирования настройки. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Является ли настройка множественной. Возможные значения:" }, "MULTILINE": { "type": "string", "description": "| Является ли поле многострочным. Используется для типа `STRING`. Возможные значения:" }, "OPTIONS": { "type": "object", "description": "| Список возможных значений свойства. Используется для типа `ENUM`." }, "TIME": { "type": "string", "description": "| Есть ли возможность выбрать время. Используется для типа `DATE`. Возможные значения:" } }, "required": [ "CODE", "SETTINGS", "PRINT_URL", "CHECK_URL", "CONFIG", "LABEL", "ITEMS", "TYPE", "REQUIRED", "OPTIONS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Код REST-обработчика. Должен быть уникальным среди всех обработчиков ||" }, "SORT": { "type": "integer", "description": "| Сортировка. Значение по умолчанию: `100` ||" }, "SUPPORTS_FFD105": { "type": "string", "description": "| Поддерживает ли касса формат фискальных данных версии 1.05. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика (подробное описание приведено ниже) ||" }, "PRINT_URL": { "type": "string", "description": "| Адрес, на который отправляются данные для печати чека ||" }, "CHECK_URL": { "type": "string", "description": "| Адрес, по которому происходит проверка статуса чека ||" }, "HTTP_VERSION": { "type": "string", "description": "| Версия протокола HTTP, используемая для запросов. Возможные значения: `1.0`, `1.1`." }, "CONFIG": { "type": "object", "description": "| Структура настроек (подробное описание приведено ниже), которые пользователь сможет устанавливать и изменять на странице редактирования кассы, а также при добавлении или обновлении кассы через REST." }, "LABEL": { "type": "string", "description": "| Заголовок раздела ||" }, "ITEMS": { "type": "object", "description": "| Список настроек раздела (подробное описание приведено ниже)." }, "TYPE": { "type": "string", "description": "| Тип настройки. Возможные значения:" }, "REQUIRED": { "type": "string", "description": "| Является ли настройка обязательной. Возможные значения:" }, "DISABLED": { "type": "string", "description": "| Отключена ли возможность редактирования настройки. Возможные значения:" }, "MULTIPLE": { "type": "string", "description": "| Является ли настройка множественной. Возможные значения:" }, "MULTILINE": { "type": "string", "description": "| Является ли поле многострочным. Используется для типа `STRING`. Возможные значения:" }, "OPTIONS": { "type": "object", "description": "| Список возможных значений свойства. Используется для типа `ENUM`." }, "TIME": { "type": "string", "description": "| Есть ли возможность выбрать время. Используется для типа `DATE`. Возможные значения:" } }, "required": [ "CODE", "SETTINGS", "PRINT_URL", "CHECK_URL", "CONFIG", "LABEL", "ITEMS", "TYPE", "REQUIRED", "OPTIONS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.handler.delete": { "post": { "summary": "Удалить обработчик кассы sale.cashbox.handler.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.handler.delete` удаляет REST-обработчик кассы.", "operationId": "sale_cashbox_handler_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-handler-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор удаляемого обработчика ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор удаляемого обработчика ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.handler.list": { "post": { "summary": "Получить список доступных обработчиков касс sale.cashbox.handler.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.handler.list` возвращает список доступных REST-обработчиков касс.", "operationId": "sale_cashbox_handler_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-handler-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.handler.update": { "post": { "summary": "Обновить данные обработчика кассы sale.cashbox.handler.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.handler.update` обновляет данные REST-обработчика кассы.", "operationId": "sale_cashbox_handler_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-handler-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обновляемого обработчика ||" }, "FIELDS": { "type": "object", "description": "| Значения обновляемых полей." } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обновляемого обработчика ||" }, "FIELDS": { "type": "object", "description": "| Значения обновляемых полей." } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.list": { "post": { "summary": "Получить список настроенных касс sale.cashbox.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.list` возвращает список настроенных касс.", "operationId": "sale_cashbox_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_cashbox) ||" }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных касс в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_cashbox) ||" }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных касс в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных записей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.cashbox.update": { "post": { "summary": "Обновить существующую кассу sale.cashbox.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.cashbox.update` обновляет существующую кассу.", "operationId": "sale_cashbox_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обновляемой кассы ||" }, "FIELDS": { "type": "object", "description": "| Значения обновляемых полей (подробное описание приведено ниже) ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков ||" }, "OFD": { "type": "string", "description": "| Код обработчика ОФД. Доступные обработчики ОФД:" }, "OFD_SETTINGS": { "type": "object", "description": "| Настройки ОФД (подробное описание приведено ниже)" }, "NUMBER_KKM": { "type": "string", "description": "| Внешний идентификатор кассы ||" }, "ACTIVE": { "type": "string", "description": "со значением `Y/N` | Активность кассы. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "USE_OFFLINE": { "type": "string", "description": "| Используется ли касса офлайн. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Настройки кассы в соответствии со структурой настроек, переданной в ключе `CONFIG` поля `SETTINGS` метода sale.cashbox.handler.add ||" }, "OFD_MODE": { "type": "object", "description": "| Настройки, относящиеся к режиму работы ОФД. Передается параметр `IS_TEST` (`string` со значениями `Y/N`) — режим работы ОФД:" }, "SELLER_INFO": { "type": "object", "description": "| Настройки раздела «Информация о продавце». Передается обязательный параметр `INN` (`string`) — ИНН продавца" }, "AUTH": { "type": "object", "description": "| Настройки авторизации. Передается параметр `INN` (`string`) — ключ безопасности" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обновляемой кассы ||" }, "FIELDS": { "type": "object", "description": "| Значения обновляемых полей (подробное описание приведено ниже) ||" }, "EMAIL": { "type": "string", "description": "| Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков ||" }, "OFD": { "type": "string", "description": "| Код обработчика ОФД. Доступные обработчики ОФД:" }, "OFD_SETTINGS": { "type": "object", "description": "| Настройки ОФД (подробное описание приведено ниже)" }, "NUMBER_KKM": { "type": "string", "description": "| Внешний идентификатор кассы ||" }, "ACTIVE": { "type": "string", "description": "со значением `Y/N` | Активность кассы. Возможные значения:" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "USE_OFFLINE": { "type": "string", "description": "| Используется ли касса офлайн. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Настройки кассы в соответствии со структурой настроек, переданной в ключе `CONFIG` поля `SETTINGS` метода sale.cashbox.handler.add ||" }, "OFD_MODE": { "type": "object", "description": "| Настройки, относящиеся к режиму работы ОФД. Передается параметр `IS_TEST` (`string` со значениями `Y/N`) — режим работы ОФД:" }, "SELLER_INFO": { "type": "object", "description": "| Настройки раздела «Информация о продавце». Передается обязательный параметр `INN` (`string`) — ИНН продавца" }, "AUTH": { "type": "object", "description": "| Настройки авторизации. Передается параметр `INN` (`string`) — ключ безопасности" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "cashbox" ] } ] } }, "/sale.delivery.add": { "post": { "summary": "Добавить службу доставки sale.delivery.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.add` добавляет службу доставки.", "operationId": "sale_delivery_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки (см. поле `CODE` объекта `sale_delivery_handler`). ||" }, "CURRENCY": { "type": "string", "description": "| Символьный код валюты службы доставки ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности службы доставки." }, "CONFIG": { "type": "string", "description": "| Значения настроек службы доставки (подробное описание приведено ниже)." }, "LOGOTYPE": { "type": "string", "description": "| Логотип службы доставки (base64-encoded строка) ||" }, "CODE": { "type": "string", "description": "| Символьный код настройки ||" }, "VALUE": { "type": "string", "description": "| Значение настройки ||" } }, "required": [ "REST_CODE", "CURRENCY", "CODE", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки (см. поле `CODE` объекта `sale_delivery_handler`). ||" }, "CURRENCY": { "type": "string", "description": "| Символьный код валюты службы доставки ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности службы доставки." }, "CONFIG": { "type": "string", "description": "| Значения настроек службы доставки (подробное описание приведено ниже)." }, "LOGOTYPE": { "type": "string", "description": "| Логотип службы доставки (base64-encoded строка) ||" }, "CODE": { "type": "string", "description": "| Символьный код настройки ||" }, "VALUE": { "type": "string", "description": "| Значение настройки ||" } }, "required": [ "REST_CODE", "CURRENCY", "CODE", "VALUE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.config.get": { "post": { "summary": "Получить настройки службы доставки sale.delivery.config.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.config.get` получает настройки службы доставки.", "operationId": "sale_delivery_config_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-config-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.config.update": { "post": { "summary": "Обновить настройки службы доставки sale.delivery.config.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.config.update` обновляет настройки службы доставки.", "operationId": "sale_delivery_config_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-config-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." }, "CONFIG": { "type": "string", "description": "| Значения настроек службы доставки (подробное описание приведено ниже)." }, "CODE": { "type": "string", "description": "| Символьный код настройки ||" }, "VALUE": { "type": "string", "description": "| Значение настройки ||" } }, "required": [ "ID", "CODE", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." }, "CONFIG": { "type": "string", "description": "| Значения настроек службы доставки (подробное описание приведено ниже)." }, "CODE": { "type": "string", "description": "| Символьный код настройки ||" }, "VALUE": { "type": "string", "description": "| Значение настройки ||" } }, "required": [ "ID", "CODE", "VALUE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.delete": { "post": { "summary": "Удалить службу доставки sale.delivery.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.delete` удаляет службу доставки.", "operationId": "sale_delivery_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.extra.service.add": { "post": { "summary": "Добавить услугу службы доставки sale.delivery.extra.service.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.extra.service.add` добавляет услугу службы доставки.", "operationId": "sale_delivery_extra_service_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой будет привязана создаваемая услуга." }, "TYPE": { "type": "string", "description": "| Тип услуги. Возможные значения:" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности услуги. Возможные значения:" }, "CODE": { "type": "string", "description": "| Символьный код услуги ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание услуги ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Стоимость услуги в валюте службы доставки." }, "ITEMS": { "type": "string", "description": "| Список доступных для выбора опций (подробное описание приведено ниже)." }, "TITLE": { "type": "string", "description": "| Название опции списка ||" } }, "required": [ "DELIVERY_ID", "TYPE", "ITEMS", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой будет привязана создаваемая услуга." }, "TYPE": { "type": "string", "description": "| Тип услуги. Возможные значения:" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности услуги. Возможные значения:" }, "CODE": { "type": "string", "description": "| Символьный код услуги ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание услуги ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Стоимость услуги в валюте службы доставки." }, "ITEMS": { "type": "string", "description": "| Список доступных для выбора опций (подробное описание приведено ниже)." }, "TITLE": { "type": "string", "description": "| Название опции списка ||" } }, "required": [ "DELIVERY_ID", "TYPE", "ITEMS", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.extra.service.delete": { "post": { "summary": "Удалить услугу службы доставки sale.delivery.extra.service.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.extra.service.delete` удаляет услугу службы доставки.", "operationId": "sale_delivery_extra_service_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор услуги." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор услуги." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.extra.service.get": { "post": { "summary": "Получить информацию обо всех услугах конкретной службы доставки sale.delivery.extra.service.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.extra.service.get` получает информацию обо всех услугах конкретной службы доставки.", "operationId": "sale_delivery_extra_service_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки ||" } }, "required": [ "DELIVERY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки ||" } }, "required": [ "DELIVERY_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.extra.service.update": { "post": { "summary": "Обновить услугу службы доставки sale.delivery.extra.service.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.extra.service.update` обновляет услугу службы доставки.", "operationId": "sale_delivery_extra_service_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор услуги." }, "ACTIVE": { "type": "string", "description": "| Индикатор активности услуги. Возможные значения:" }, "CODE": { "type": "string", "description": "| Символьный код услуги ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание услуги ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Стоимость услуги в валюте службы доставки." }, "ITEMS": { "type": "string", "description": "| Список доступных для выбора опций (подробное описание приведено ниже)." }, "TITLE": { "type": "string", "description": "| Название опции списка ||" } }, "required": [ "ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор услуги." }, "ACTIVE": { "type": "string", "description": "| Индикатор активности услуги. Возможные значения:" }, "CODE": { "type": "string", "description": "| Символьный код услуги ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание услуги ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Стоимость услуги в валюте службы доставки." }, "ITEMS": { "type": "string", "description": "| Список доступных для выбора опций (подробное описание приведено ниже)." }, "TITLE": { "type": "string", "description": "| Название опции списка ||" } }, "required": [ "ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.getlist": { "post": { "summary": "Получить список служб доставки sale.delivery.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.getlist` получает список служб доставки.", "operationId": "sale_delivery_getlist", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта `sale_delivery_service`)." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных служб доставок в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных служб доставки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта `sale_delivery_service`)." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных служб доставок в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных служб доставки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.handler.add": { "post": { "summary": "Добавить обработчик службы доставки sale.delivery.handler.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.handler.add` добавляет обработчик службы доставки.", "operationId": "sale_delivery_handler_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/handler/sale-delivery-handler-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "integer", "description": "| Описание обработчика службы доставки ||" }, "SETTINGS": { "type": "object", "description": "| Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже) ||" }, "PROFILES": { "type": "string", "description": "| Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже)." }, "CALCULATE_URL": { "type": "string", "description": "| URL для расчета стоимости доставки." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для создания заказа на доставку." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для отмены заказа на доставку" }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Тип поля настройки" }, "OPTIONS": { "type": "object", "description": "| Список опций для выбора. Объект в формате `ключ=значение`. Где ключ — код опции, а значение — опция." } }, "required": [ "CODE", "SETTINGS", "PROFILES", "CALCULATE_URL", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "integer", "description": "| Описание обработчика службы доставки ||" }, "SETTINGS": { "type": "object", "description": "| Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже) ||" }, "PROFILES": { "type": "string", "description": "| Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже)." }, "CALCULATE_URL": { "type": "string", "description": "| URL для расчета стоимости доставки." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для создания заказа на доставку." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для отмены заказа на доставку" }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Тип поля настройки" }, "OPTIONS": { "type": "object", "description": "| Список опций для выбора. Объект в формате `ключ=значение`. Где ключ — код опции, а значение — опция." } }, "required": [ "CODE", "SETTINGS", "PROFILES", "CALCULATE_URL", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.handler.delete": { "post": { "summary": "Удалить обработчик службы доставки sale.delivery.handler.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.handler.delete` удаляет обработчик службы доставки.", "operationId": "sale_delivery_handler_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/handler/sale-delivery-handler-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обработчика службы доставки ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обработчика службы доставки ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.handler.list": { "post": { "summary": "Получить список обработчиков служб доставки sale.delivery.handler.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.handler.list` получает список обработчиков служб доставки.", "operationId": "sale_delivery_handler_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/handler/sale-delivery-handler-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.handler.update": { "post": { "summary": "Обновить обработчик службы доставки sale.delivery.handler.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.handler.update` обновляет обработчик службы доставки.", "operationId": "sale_delivery_handler_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/handler/sale-delivery-handler-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обработчика службы доставки." }, "CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание обработчика службы доставки ||" }, "SETTINGS": { "type": "object", "description": "| Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже) ||" }, "PROFILES": { "type": "string", "description": "| Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже)." }, "CALCULATE_URL": { "type": "string", "description": "| URL для расчета стоимости доставки." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для создания заказа на доставку." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для отмены заказа на доставку" }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Тип поля настройки" }, "OPTIONS": { "type": "object", "description": "| Список опций для выбора. Объект в формате `ключ=значение`. Где ключ — код опции, а значение — опция." } }, "required": [ "ID", "CALCULATE_URL", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор обработчика службы доставки." }, "CODE": { "type": "string", "description": "| Символьный код обработчика службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание обработчика службы доставки ||" }, "SETTINGS": { "type": "object", "description": "| Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже) ||" }, "PROFILES": { "type": "string", "description": "| Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже)." }, "CALCULATE_URL": { "type": "string", "description": "| URL для расчета стоимости доставки." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для создания заказа на доставку." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL для отмены заказа на доставку" }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Тип поля настройки" }, "OPTIONS": { "type": "object", "description": "| Список опций для выбора. Объект в формате `ключ=значение`. Где ключ — код опции, а значение — опция." } }, "required": [ "ID", "CALCULATE_URL", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.request.delete": { "post": { "summary": "Удалить транспортную заявку sale.delivery.request.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.request.delete` удаляет транспортную заявку.", "operationId": "sale_delivery_request_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." } }, "required": [ "DELIVERY_ID", "REQUEST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." } }, "required": [ "DELIVERY_ID", "REQUEST_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.request.sendmessage": { "post": { "summary": "Создать оповещения по транспортной заявке sale.delivery.request.sendmessage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.request.sendmessage` создает оповещения по транспортной заявке.", "operationId": "sale_delivery_request_sendmessage", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." }, "ADDRESSEE": { "type": "string", "description": "| Адресат сообщения." }, "MESSAGE": { "type": "object", "description": "| Сообщение (подробное описание приведено ниже)" }, "SUBJECT": { "type": "string", "description": "| Заголовок сообщения." }, "BODY": { "type": "string", "description": "| Тело сообщения." }, "STATUS": { "type": "object", "description": "| Статус сообщения (подробное описание приведено ниже)" }, "MONEY_VALUES": { "type": "object", "description": "| Объект в формате `ключ => значение`." }, "SEMANTIC": { "type": "string", "description": "| Значение семантики статуса." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "ADDRESSEE", "MESSAGE", "SUBJECT", "BODY", "SEMANTIC" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." }, "ADDRESSEE": { "type": "string", "description": "| Адресат сообщения." }, "MESSAGE": { "type": "object", "description": "| Сообщение (подробное описание приведено ниже)" }, "SUBJECT": { "type": "string", "description": "| Заголовок сообщения." }, "BODY": { "type": "string", "description": "| Тело сообщения." }, "STATUS": { "type": "object", "description": "| Статус сообщения (подробное описание приведено ниже)" }, "MONEY_VALUES": { "type": "object", "description": "| Объект в формате `ключ => значение`." }, "SEMANTIC": { "type": "string", "description": "| Значение семантики статуса." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "ADDRESSEE", "MESSAGE", "SUBJECT", "BODY", "SEMANTIC" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.request.update": { "post": { "summary": "Обновить транспортную заявку sale.delivery.request.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.request.update` обновляет транспортную заявку.", "operationId": "sale_delivery_request_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery-request/sale-delivery-request-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." }, "FINALIZE": { "type": "string", "description": "| Индикатор необходимости завершить (финализировать) транспортную заявку." }, "STATUS": { "type": "object", "description": "| Статус транспортной заявки (подробное описание приведено ниже) ||" }, "PROPERTIES": { "type": "string", "description": "| Свойства транспортной заявки (подробное описание приведено ниже) ||" }, "OVERWRITE_PROPERTIES": { "type": "string", "description": "| Индикатор необходимости полностью переписать значения свойств заявки при обновлении." }, "TEXT": { "type": "string", "description": "| Текстовое название статуса транспортной заявки ||" }, "SEMANTIC": { "type": "string", "description": "| Значение семантики статуса." }, "VALUE": { "type": "string", "description": "| Значение свойства ||" }, "TAGS": { "type": "string", "description": "| Список тегов." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "TEXT", "SEMANTIC", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Идентификатор службы доставки, к которой относится транспортная заявка." }, "REQUEST_ID": { "type": "string", "description": "| Идентификатор транспортной заявки." }, "FINALIZE": { "type": "string", "description": "| Индикатор необходимости завершить (финализировать) транспортную заявку." }, "STATUS": { "type": "object", "description": "| Статус транспортной заявки (подробное описание приведено ниже) ||" }, "PROPERTIES": { "type": "string", "description": "| Свойства транспортной заявки (подробное описание приведено ниже) ||" }, "OVERWRITE_PROPERTIES": { "type": "string", "description": "| Индикатор необходимости полностью переписать значения свойств заявки при обновлении." }, "TEXT": { "type": "string", "description": "| Текстовое название статуса транспортной заявки ||" }, "SEMANTIC": { "type": "string", "description": "| Значение семантики статуса." }, "VALUE": { "type": "string", "description": "| Значение свойства ||" }, "TAGS": { "type": "string", "description": "| Список тегов." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "TEXT", "SEMANTIC", "VALUE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.delivery.update": { "post": { "summary": "Обновить службу доставки sale.delivery.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.delivery.update` обновляет службу доставки.", "operationId": "sale_delivery_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/delivery/delivery/sale-delivery-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." }, "CURRENCY": { "type": "string", "description": "| Символьный код валюты службы доставки ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности службы доставки." }, "LOGOTYPE": { "type": "string", "description": "| Логотип службы доставки (base64-encoded строка) ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор службы доставки." }, "CURRENCY": { "type": "string", "description": "| Символьный код валюты службы доставки ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание службы доставки ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности службы доставки." }, "LOGOTYPE": { "type": "string", "description": "| Логотип службы доставки (base64-encoded строка) ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "delivery" ] } ] } }, "/sale.order.add": { "post": { "summary": "Добавить заказ sale.order.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.add` создает заказ без позиций корзины, оплат и отгрузок и возвращает его поля. Позиции корзины, оплаты и отгрузки добавляют после создания методами [sale.basketitem.*](../basket-item/index.md), [sale.payment.*](../payment/index.md) и [sale.shipment.*](../shipment/index.md).", "operationId": "sale_order_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания заказа (подробное описание) ||" }, "lid": { "type": "string", "description": "| Идентификатор сайта, к которому относится заказ. В облачном Битрикс24 передавайте `s1`. После создания заказа поле изменить нельзя ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика, например физического или юридического лица. Получите его методом sale.persontype.list. Метод не проверяет, что такой тип плательщика существует. После создания заказа поле изменить нельзя ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Получите список валют методом crm.currency.list. После создания заказа поле изменить нельзя ||" }, "price": { "type": "number", "format": "double", "description": "| Сумма заказа с учетом доставки ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Значение скидки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса заказа. Получите список статусов методом sale.status.list. Если не передать поле, заказ получит начальный статус `N` ||" }, "empStatusId": { "type": "string", "description": "| Идентификатор пользователя, изменившего статус заказа ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Дата создания заказа ||" }, "marked": { "type": "string", "description": "| Признак того, что заказ отмечен как проблемный. Битрикс24 ставит `Y` автоматически, если при сохранении заказа возникло предупреждение. Причину он записывает в поле `reasonMarked`." }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, поставившего маркировку ||" }, "reasonMarked": { "type": "string", "description": "| Причина, по которой заказ отмечен как проблемный ||" }, "userDescription": { "type": "string", "description": "| Комментарий покупателя к заказу ||" }, "additionalInfo": { "type": "string", "description": "| Устаревший." }, "comments": { "type": "string", "description": "| Комментарий менеджера к заказу ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин» ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за заказ ||" }, "recurringId": { "type": "string", "description": "| Идентификатор продления подписки ||" }, "lockedBy": { "type": "string", "description": "| Актуально только для коробочной версии." }, "recountFlag": { "type": "string", "description": "| Устаревший." }, "affiliateId": { "type": "integer", "description": "| Актуально только для коробочной версии." }, "updated1c": { "type": "string", "description": "| Обновлен ли заказ через 1С." }, "orderTopic": { "type": "string", "description": "| Устаревший." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия в 1С ||" }, "externalOrder": { "type": "string", "description": "| Заказ из внешней системы или нет." }, "canceled": { "type": "string", "description": "| Был ли отменен заказ." }, "empCanceledId": { "type": "string", "description": "| Идентификатор пользователя, отменившего заказ ||" }, "reasonCanceled": { "type": "string", "description": "| Причина отмены ||" }, "userId": { "type": "string", "description": "| Идентификатор покупателя. После создания заказа поле изменить нельзя ||" } }, "required": [ "fields", "lid", "personTypeId", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания заказа (подробное описание) ||" }, "lid": { "type": "string", "description": "| Идентификатор сайта, к которому относится заказ. В облачном Битрикс24 передавайте `s1`. После создания заказа поле изменить нельзя ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика, например физического или юридического лица. Получите его методом sale.persontype.list. Метод не проверяет, что такой тип плательщика существует. После создания заказа поле изменить нельзя ||" }, "currency": { "type": "string", "description": "| Код валюты, например `RUB`. Получите список валют методом crm.currency.list. После создания заказа поле изменить нельзя ||" }, "price": { "type": "number", "format": "double", "description": "| Сумма заказа с учетом доставки ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Значение скидки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса заказа. Получите список статусов методом sale.status.list. Если не передать поле, заказ получит начальный статус `N` ||" }, "empStatusId": { "type": "string", "description": "| Идентификатор пользователя, изменившего статус заказа ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Дата создания заказа ||" }, "marked": { "type": "string", "description": "| Признак того, что заказ отмечен как проблемный. Битрикс24 ставит `Y` автоматически, если при сохранении заказа возникло предупреждение. Причину он записывает в поле `reasonMarked`." }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, поставившего маркировку ||" }, "reasonMarked": { "type": "string", "description": "| Причина, по которой заказ отмечен как проблемный ||" }, "userDescription": { "type": "string", "description": "| Комментарий покупателя к заказу ||" }, "additionalInfo": { "type": "string", "description": "| Устаревший." }, "comments": { "type": "string", "description": "| Комментарий менеджера к заказу ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин» ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за заказ ||" }, "recurringId": { "type": "string", "description": "| Идентификатор продления подписки ||" }, "lockedBy": { "type": "string", "description": "| Актуально только для коробочной версии." }, "recountFlag": { "type": "string", "description": "| Устаревший." }, "affiliateId": { "type": "integer", "description": "| Актуально только для коробочной версии." }, "updated1c": { "type": "string", "description": "| Обновлен ли заказ через 1С." }, "orderTopic": { "type": "string", "description": "| Устаревший." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия в 1С ||" }, "externalOrder": { "type": "string", "description": "| Заказ из внешней системы или нет." }, "canceled": { "type": "string", "description": "| Был ли отменен заказ." }, "empCanceledId": { "type": "string", "description": "| Идентификатор пользователя, отменившего заказ ||" }, "reasonCanceled": { "type": "string", "description": "| Причина отмены ||" }, "userId": { "type": "string", "description": "| Идентификатор покупателя. После создания заказа поле изменить нельзя ||" } }, "required": [ "fields", "lid", "personTypeId", "currency" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.delete": { "post": { "summary": "Удалить заказ sale.order.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.delete` удаляет заказ вместе с позициями корзины, оплатами и отгрузками. Восстановить удаленный заказ нельзя. Значения свойств заказа метод не удаляет — их по-прежнему возвращает [sale.propertyvalue.list](../property-value/sale-property-value-list.md) с фильтром по `orderId`.", "operationId": "sale_order_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа, который нужно удалить. Его возвращают методы sale.order.add и sale.order.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа, который нужно удалить. Его возвращают методы sale.order.add и sale.order.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.get": { "post": { "summary": "Получить значения полей заказа и связанных объектов sale.order.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.get` возвращает все поля заказа вместе со связанными объектами, например позициями корзины, оплатами, отгрузками, значениями свойств и клиентами CRM. Чтобы получить только поля самого заказа или несколько заказов сразу, используйте [sale.order.list](./sale-order-list.md).", "operationId": "sale_order_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа. Его возвращают методы sale.order.add и sale.order.list. Не путайте с номером заказа `accountNumber` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа. Его возвращают методы sale.order.add и sale.order.list. Не путайте с номером заказа `accountNumber` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.getFields": { "post": { "summary": "Получить поля заказа sale.order.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.getFields` возвращает описание полей заказа: тип каждого поля, обязательно ли оно при создании и можно ли его изменить. По ответу проверяйте имена полей для `select` и `filter` в [sale.order.list](./sale-order-list.md) и состав `fields` для [sale.order.add](./sale-order-add.md) и [sale.order.update](./sale-order-update.md).", "operationId": "sale_order_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.list": { "post": { "summary": "Получить список заказов sale.order.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.list` возвращает список заказов с фильтрацией, сортировкой и постраничной навигацией. В ответ попадают только поля заказа: позиции корзины, оплаты, отгрузки и значения свойств отдает метод [sale.order.get](./sale-order-get.md).", "operationId": "sale_order_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Поля заказа, которые нужно вернуть. Имена полей — в объекте sale_order." }, "filter": { "type": "object", "description": "| Условия отбора заказов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — поле объекта sale_order." }, "order": { "type": "object", "description": "| Порядок сортировки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field` — поле объекта sale_order, а `order` — направление:" }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. На странице до 50 заказов, размер страницы изменить нельзя." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Поля заказа, которые нужно вернуть. Имена полей — в объекте sale_order." }, "filter": { "type": "object", "description": "| Условия отбора заказов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — поле объекта sale_order." }, "order": { "type": "object", "description": "| Порядок сортировки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, где `field` — поле объекта sale_order, а `order` — направление:" }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. На странице до 50 заказов, размер страницы изменить нельзя." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.update": { "post": { "summary": "Изменить заказ sale.order.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.order.update` изменяет поля заказа и возвращает заказ после изменения.", "operationId": "sale_order_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/order/sale-order-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа. Его возвращают методы sale.order.add и sale.order.list ||" }, "fields": { "type": "object", "description": "| Поля, которые нужно изменить. Непереданные поля сохраняют прежние значения, пустой объект вернет заказ без изменений (подробное описание) ||" }, "price": { "type": "number", "format": "double", "description": "| Сумма заказа с учетом доставки ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Значение скидки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса заказа. Список статусов возвращает метод sale.status.list ||" }, "empStatusId": { "type": "string", "description": "| Идентификатор пользователя, изменившего статус заказа ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Дата создания заказа ||" }, "marked": { "type": "string", "description": "| Признак того, что заказ отмечен как проблемный. Битрикс24 ставит `Y` автоматически, если при сохранении заказа возникло предупреждение. Причину Битрикс24 записывает в поле `reasonMarked`." }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, поставившего маркировку ||" }, "reasonMarked": { "type": "string", "description": "| Причина, по которой заказ был промаркирован ||" }, "userDescription": { "type": "string", "description": "| Комментарий покупателя к заказу ||" }, "additionalInfo": { "type": "string", "description": "| Устаревший." }, "comments": { "type": "string", "description": "| Комментарий менеджера к заказу ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин» ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за заказ ||" }, "recurringId": { "type": "string", "description": "| Идентификатор продления подписки ||" }, "lockedBy": { "type": "string", "description": "| Актуально только для коробочной версии." }, "recountFlag": { "type": "string", "description": "| Устаревший." }, "affiliateId": { "type": "integer", "description": "| Актуально только для коробочной версии." }, "updated1c": { "type": "string", "description": "| Обновлен ли заказ через 1С." }, "orderTopic": { "type": "string", "description": "| Устаревший." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия в 1С ||" }, "externalOrder": { "type": "string", "description": "| Заказ из внешней системы или нет." }, "canceled": { "type": "string", "description": "| Был ли отменен заказ." }, "empCanceledId": { "type": "string", "description": "| Идентификатор пользователя, отменившего заказ ||" }, "reasonCanceled": { "type": "string", "description": "| Причина отмены ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор заказа. Его возвращают методы sale.order.add и sale.order.list ||" }, "fields": { "type": "object", "description": "| Поля, которые нужно изменить. Непереданные поля сохраняют прежние значения, пустой объект вернет заказ без изменений (подробное описание) ||" }, "price": { "type": "number", "format": "double", "description": "| Сумма заказа с учетом доставки ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Значение скидки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса заказа. Список статусов возвращает метод sale.status.list ||" }, "empStatusId": { "type": "string", "description": "| Идентификатор пользователя, изменившего статус заказа ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Дата создания заказа ||" }, "marked": { "type": "string", "description": "| Признак того, что заказ отмечен как проблемный. Битрикс24 ставит `Y` автоматически, если при сохранении заказа возникло предупреждение. Причину Битрикс24 записывает в поле `reasonMarked`." }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, поставившего маркировку ||" }, "reasonMarked": { "type": "string", "description": "| Причина, по которой заказ был промаркирован ||" }, "userDescription": { "type": "string", "description": "| Комментарий покупателя к заказу ||" }, "additionalInfo": { "type": "string", "description": "| Устаревший." }, "comments": { "type": "string", "description": "| Комментарий менеджера к заказу ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин» ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за заказ ||" }, "recurringId": { "type": "string", "description": "| Идентификатор продления подписки ||" }, "lockedBy": { "type": "string", "description": "| Актуально только для коробочной версии." }, "recountFlag": { "type": "string", "description": "| Устаревший." }, "affiliateId": { "type": "integer", "description": "| Актуально только для коробочной версии." }, "updated1c": { "type": "string", "description": "| Обновлен ли заказ через 1С." }, "orderTopic": { "type": "string", "description": "| Устаревший." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия в 1С ||" }, "externalOrder": { "type": "string", "description": "| Заказ из внешней системы или нет." }, "canceled": { "type": "string", "description": "| Был ли отменен заказ." }, "empCanceledId": { "type": "string", "description": "| Идентификатор пользователя, отменившего заказ ||" }, "reasonCanceled": { "type": "string", "description": "| Причина отмены ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.add": { "post": { "summary": "Добавить оплату sale.payment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.add` добавляет новую оплату.", "operationId": "sale_payment_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "paySystemId": { "type": "string", "description": "| Идентификатор платежной системы ||" }, "paid": { "type": "string", "description": "| Оплата оплачена:" }, "datePaid": { "type": "string", "format": "date-time", "description": "| Дата оплаты ||" }, "empPaidId": { "type": "string", "description": "| Идентификатор пользователя, который оплатил оплату ||" }, "psStatus": { "type": "string", "description": "| Флаг статуса платежной системы — успешно ли оплачена оплата. Варианты:" }, "psStatusCode": { "type": "string", "description": "| Код статуса платёжной системы ||" }, "psStatusDescription": { "type": "string", "description": "| Описание результата работы платежной системы ||" }, "psStatusMessage": { "type": "string", "description": "| Сообщение от платежной системы ||" }, "psSum": { "type": "number", "format": "double", "description": "| Сумма платежной системы ||" }, "psCurrency": { "type": "string", "description": "| Валюта платежной системы ||" }, "psResponseDate": { "type": "string", "format": "date-time", "description": "| Дата ответа платежной системы ||" }, "payVoucherNum": { "type": "string", "description": "| Номер платежного документа ||" }, "payVoucherDate": { "type": "string", "format": "date-time", "description": "| Дата платежного документа ||" }, "datePayBefore": { "type": "string", "format": "date-time", "description": "| Устаревший." }, "dateBill": { "type": "string", "format": "date-time", "description": "| Дата выставления счета ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "sum": { "type": "number", "format": "double", "description": "| Сумма оплаты ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании, которая будет принимать оплату" }, "payReturnNum": { "type": "string", "description": "| Номер документа возврата ||" }, "priceCod": { "type": "number", "format": "double", "description": "| Актуально только для коробочной версии" }, "payReturnDate": { "type": "string", "format": "date", "description": "| Дата документа возврата ||" }, "empReturnId": { "type": "string", "description": "| Идентификатор пользователя, который выполнял возврат ||" }, "payReturnComment": { "type": "string", "description": "| Комментарий к возврату ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за оплату ||" }, "empResponsibleId": { "type": "string", "description": "| Идентификатор пользователя, назначившего ответственного ||" }, "isReturn": { "type": "string", "description": "| Выполнялся ли возврат:" }, "comments": { "type": "string", "description": "| Комментарии к оплате ||" }, "updated1c": { "type": "string", "description": "| Оплата обновлена через 1С:" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия документа оплаты от 1С ||" }, "externalPayment": { "type": "string", "description": "| Актуально только для коробочной версии" }, "psInvoiceId": { "type": "string", "description": "| Идентификатор оплаты в платежной системе ||" }, "marked": { "type": "string", "description": "| Флаг маркировки. Признак того, является ли оплата отмеченной как проблемная:" }, "reasonMarked": { "type": "string", "description": "| Причина маркировки ||" }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, промаркировавшего оплату ||" } }, "required": [ "fields", "orderId", "paySystemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "paySystemId": { "type": "string", "description": "| Идентификатор платежной системы ||" }, "paid": { "type": "string", "description": "| Оплата оплачена:" }, "datePaid": { "type": "string", "format": "date-time", "description": "| Дата оплаты ||" }, "empPaidId": { "type": "string", "description": "| Идентификатор пользователя, который оплатил оплату ||" }, "psStatus": { "type": "string", "description": "| Флаг статуса платежной системы — успешно ли оплачена оплата. Варианты:" }, "psStatusCode": { "type": "string", "description": "| Код статуса платёжной системы ||" }, "psStatusDescription": { "type": "string", "description": "| Описание результата работы платежной системы ||" }, "psStatusMessage": { "type": "string", "description": "| Сообщение от платежной системы ||" }, "psSum": { "type": "number", "format": "double", "description": "| Сумма платежной системы ||" }, "psCurrency": { "type": "string", "description": "| Валюта платежной системы ||" }, "psResponseDate": { "type": "string", "format": "date-time", "description": "| Дата ответа платежной системы ||" }, "payVoucherNum": { "type": "string", "description": "| Номер платежного документа ||" }, "payVoucherDate": { "type": "string", "format": "date-time", "description": "| Дата платежного документа ||" }, "datePayBefore": { "type": "string", "format": "date-time", "description": "| Устаревший." }, "dateBill": { "type": "string", "format": "date-time", "description": "| Дата выставления счета ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "sum": { "type": "number", "format": "double", "description": "| Сумма оплаты ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании, которая будет принимать оплату" }, "payReturnNum": { "type": "string", "description": "| Номер документа возврата ||" }, "priceCod": { "type": "number", "format": "double", "description": "| Актуально только для коробочной версии" }, "payReturnDate": { "type": "string", "format": "date", "description": "| Дата документа возврата ||" }, "empReturnId": { "type": "string", "description": "| Идентификатор пользователя, который выполнял возврат ||" }, "payReturnComment": { "type": "string", "description": "| Комментарий к возврату ||" }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за оплату ||" }, "empResponsibleId": { "type": "string", "description": "| Идентификатор пользователя, назначившего ответственного ||" }, "isReturn": { "type": "string", "description": "| Выполнялся ли возврат:" }, "comments": { "type": "string", "description": "| Комментарии к оплате ||" }, "updated1c": { "type": "string", "description": "| Оплата обновлена через 1С:" }, "id1c": { "type": "string", "description": "| Идентификатор в 1С ||" }, "version1c": { "type": "string", "description": "| Версия документа оплаты от 1С ||" }, "externalPayment": { "type": "string", "description": "| Актуально только для коробочной версии" }, "psInvoiceId": { "type": "string", "description": "| Идентификатор оплаты в платежной системе ||" }, "marked": { "type": "string", "description": "| Флаг маркировки. Признак того, является ли оплата отмеченной как проблемная:" }, "reasonMarked": { "type": "string", "description": "| Причина маркировки ||" }, "empMarkedId": { "type": "string", "description": "| Идентификатор пользователя, промаркировавшего оплату ||" } }, "required": [ "fields", "orderId", "paySystemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.delete": { "post": { "summary": "Удалить оплату sale.payment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.delete` удаляет оплату.", "operationId": "sale_payment_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.get": { "post": { "summary": "Получить оплату по Id sale.payment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.get` получает значения всех полей оплаты по идентификатору.", "operationId": "sale_payment_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.getFields": { "post": { "summary": "Получить поля оплаты sale.payment.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.getFields` получает доступные поля оплаты.", "operationId": "sale_payment_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.list": { "post": { "summary": "Получить список оплат sale.payment.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.list` получает список оплат.", "operationId": "sale_payment_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных оплат в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных оплат в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных оплат в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных оплат в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.update": { "post": { "summary": "Изменить оплату sale.payment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.payment.update` служит для обновления полей элемента коллекции оплат.", "operationId": "sale_payment_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment/sale-payment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.add": { "post": { "summary": "Добавить привязку оплаты к отгрузке sale.paymentItemShipment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.add` добавляет привязку оплаты к отгрузке.", "operationId": "sale_paymentItemShipment_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания привязки оплаты к отгрузке в виде структуры:" }, "shipmentId": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "paymentId": { "type": "string", "description": "| Идентификатор оплаты ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "fields", "shipmentId", "paymentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания привязки оплаты к отгрузке в виде структуры:" }, "shipmentId": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "paymentId": { "type": "string", "description": "| Идентификатор оплаты ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "fields", "shipmentId", "paymentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.delete": { "post": { "summary": "Удалить привязку sale.paymentItemShipment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.delete` удаляет привязку оплаты к отгрузке.", "operationId": "sale_paymentItemShipment_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.get": { "post": { "summary": "Получить привязку по Id sale.paymentItemShipment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.get` получает привязку оплаты к отгрузке по идентификатору.", "operationId": "sale_paymentItemShipment_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.getFields": { "post": { "summary": "Получить поля привязки sale.paymentItemShipment.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.getFields` получает доступные поля элементов табличной части привязки оплаты к отгрузке.", "operationId": "sale_paymentItemShipment_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.list": { "post": { "summary": "Получить список привязок sale.paymentItemShipment.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.list` получает список привязок оплат к отгрузкам по фильтру.", "operationId": "sale_paymentItemShipment_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_payment_item_shipment)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_payment_item_shipment)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.update": { "post": { "summary": "Изменить привязку оплаты к отгрузке sale.paymentItemShipment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentItemShipment.update` изменяет привязку оплаты к отгрузке.", "operationId": "sale_paymentItemShipment_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания привязки оплаты к отгрузке в виде структуры:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки оплаты к отгрузке ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания привязки оплаты к отгрузке в виде структуры:" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.add": { "post": { "summary": "Добавить привязку элемента корзины к оплате sale.paymentitembasket.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.add` добавляет привязку элемента корзины к оплате.", "operationId": "sale_paymentitembasket_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки элемента корзины к оплате ||" }, "paymentId": { "type": "string", "description": "| Идентификатор оплаты ||" }, "basketId": { "type": "string", "description": "| Идентификатор элемента корзины ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "fields", "paymentId", "basketId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки элемента корзины к оплате ||" }, "paymentId": { "type": "string", "description": "| Идентификатор оплаты ||" }, "basketId": { "type": "string", "description": "| Идентификатор элемента корзины ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "fields", "paymentId", "basketId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.delete": { "post": { "summary": "Удалить привязку элемента корзины к оплате sale.paymentitembasket.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.delete` удаляет привязку элемента корзины к оплате.", "operationId": "sale_paymentitembasket_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.get": { "post": { "summary": "Получить значения всех полей привязки элемента корзины к оплате sale.paymentitembasket.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.get` получает значения всех полей привязки элемента корзины к оплате.", "operationId": "sale_paymentitembasket_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.getfields": { "post": { "summary": "Получить доступные поля привязок элементов корзины к оплатам sale.paymentitembasket.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.getfields` получает доступные поля привязок элементов корзины к оплатам.", "operationId": "sale_paymentitembasket_getfields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.list": { "post": { "summary": "Получить список привязок элементов корзины к оплатам sale.paymentitembasket.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.list` получает список привязок элементов корзины к оплатам.", "operationId": "sale_paymentitembasket_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (см. поля объекта sale_payment_item_basket)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок элементов корзины к оплатам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок элементов корзины к оплатам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (см. поля объекта sale_payment_item_basket)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок элементов корзины к оплатам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок элементов корзины к оплатам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.update": { "post": { "summary": "Обновить привязку элемента корзины к оплате sale.paymentitembasket.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.paymentitembasket.update` обновляет привязку элемента корзины к оплате.", "operationId": "sale_paymentitembasket_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/payment-item-basket/sale-payment-item-basket-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления привязки элемента корзины к оплате ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор привязки элемента корзины к оплате ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления привязки элемента корзины к оплате ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор записи ||" } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paysystem.add": { "post": { "summary": "Добавить платежную систему sale.paysystem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет платежную систему.", "operationId": "sale_paysystem_add", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DESCRIPTION": { "type": "string", "description": "| Описание платежной системы ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности платежной системы. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Список значений настроек обработчика в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — название настройки, а `value` — объект, содержащий ключи TYPE и VALUE (описание смотрите ниже)." }, "ENTITY_REGISTRY_TYPE": { "type": "string", "description": "| Привязка платежной системы:" }, "LOGOTYPE": { "type": "string", "description": "| Логотип платежной системы (картинка в формате Base64) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор платежной системы. Может быть использован как дополнительный параметр для фильтрации в sale.paysystem.list ||" }, "ORDER": { "type": "string", "description": "| Параметры ||" }, "PROPERTY": { "type": "string", "description": "| Свойства счета ||" }, "PAYMENT": { "type": "string", "description": "| Оплата ||" }, "USER": { "type": "string", "description": "| Пользователь ||" }, "VALUE": { "type": "string", "description": "| Произвольное значение типа строка ||" } }, "required": [ "PERSON_TYPE_ID", "BX_REST_HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DESCRIPTION": { "type": "string", "description": "| Описание платежной системы ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности платежной системы. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Список значений настроек обработчика в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, где `field` — название настройки, а `value` — объект, содержащий ключи TYPE и VALUE (описание смотрите ниже)." }, "ENTITY_REGISTRY_TYPE": { "type": "string", "description": "| Привязка платежной системы:" }, "LOGOTYPE": { "type": "string", "description": "| Логотип платежной системы (картинка в формате Base64) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор платежной системы. Может быть использован как дополнительный параметр для фильтрации в sale.paysystem.list ||" }, "ORDER": { "type": "string", "description": "| Параметры ||" }, "PROPERTY": { "type": "string", "description": "| Свойства счета ||" }, "PAYMENT": { "type": "string", "description": "| Оплата ||" }, "USER": { "type": "string", "description": "| Пользователь ||" }, "VALUE": { "type": "string", "description": "| Произвольное значение типа строка ||" } }, "required": [ "PERSON_TYPE_ID", "BX_REST_HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.delete": { "post": { "summary": "Удалить платежную систему sale.paysystem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет платежную систему.", "operationId": "sale_paysystem_delete", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.add": { "post": { "summary": "Добавить REST-обработчик платежной системы sale.paysystem.handler.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет REST-обработчик платежной системы.", "operationId": "sale_paysystem_handler_add", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-handler-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию `100` ||" }, "CODE": { "type": "string", "description": "| Код REST-обработчика. Должен быть уникальным среди всех обработчиков ||" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика (подробное описание приведено ниже) ||" }, "CODES": { "type": "object", "description": "| Список параметров обработчика. Ключами являются коды параметров (`string`), значениями — описания параметров (подробное описание приведено ниже)." }, "FORM_DATA": { "type": "object", "description": "| Настройки формы при использовании режима работы в форме ||" }, "CHECKOUT_DATA": { "type": "object", "description": "| Настройки режима Checkout (создание заказа на стороне сервиса и переход покупателя на эту страницу для оплаты) ||" }, "IFRAME_DATA": { "type": "object", "description": "| Настройки страницы, выводимой в iframe на сайте продавца на странице оплаты ||" }, "CLIENT_TYPE": { "type": "string", "description": "| Тип покупателей, с которыми может работать обработчик. Доступные значения:" }, "CURRENCY": { "type": "string", "description": "| Список валют, работа с которыми поддерживается платежной системой. По умолчанию пуст ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание параметра ||" }, "GROUP": { "type": "string", "description": "| Код группы, к которой относится параметр ||" }, "DEFAULT": { "type": "object", "description": "| Описание значения по умолчанию (подробное описание приведено ниже)" }, "INPUT": { "type": "object", "description": "| Объект, описывающий поле ввода. Структура объекта содержит параметр `TYPE` — тип поля. Поддерживаемые поля:" }, "PROVIDER_KEY": { "type": "string", "description": "| Ключ провайдера, из которого будет браться значение по умолчанию. Возможные значения ключа приведены ниже ||" }, "PROVIDER_VALUE": { "type": "string", "description": "| Код значения, которое будет взято у провайдера. Возможные значения ключа приведены ниже ||" }, "ORDER": { "type": "string", "description": "| Заказ ||" }, "PROPERTY": { "type": "string", "description": "| Свойства счета ||" }, "PAYMENT": { "type": "string", "description": "| Оплата ||" }, "USER": { "type": "string", "description": "| Пользователь ||" }, "VALUE": { "type": "string", "description": "| Произвольное значение типа строка ||" } }, "required": [ "CODE", "SETTINGS", "CODES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "integer", "description": "| Сортировка. По умолчанию `100` ||" }, "CODE": { "type": "string", "description": "| Код REST-обработчика. Должен быть уникальным среди всех обработчиков ||" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика (подробное описание приведено ниже) ||" }, "CODES": { "type": "object", "description": "| Список параметров обработчика. Ключами являются коды параметров (`string`), значениями — описания параметров (подробное описание приведено ниже)." }, "FORM_DATA": { "type": "object", "description": "| Настройки формы при использовании режима работы в форме ||" }, "CHECKOUT_DATA": { "type": "object", "description": "| Настройки режима Checkout (создание заказа на стороне сервиса и переход покупателя на эту страницу для оплаты) ||" }, "IFRAME_DATA": { "type": "object", "description": "| Настройки страницы, выводимой в iframe на сайте продавца на странице оплаты ||" }, "CLIENT_TYPE": { "type": "string", "description": "| Тип покупателей, с которыми может работать обработчик. Доступные значения:" }, "CURRENCY": { "type": "string", "description": "| Список валют, работа с которыми поддерживается платежной системой. По умолчанию пуст ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание параметра ||" }, "GROUP": { "type": "string", "description": "| Код группы, к которой относится параметр ||" }, "DEFAULT": { "type": "object", "description": "| Описание значения по умолчанию (подробное описание приведено ниже)" }, "INPUT": { "type": "object", "description": "| Объект, описывающий поле ввода. Структура объекта содержит параметр `TYPE` — тип поля. Поддерживаемые поля:" }, "PROVIDER_KEY": { "type": "string", "description": "| Ключ провайдера, из которого будет браться значение по умолчанию. Возможные значения ключа приведены ниже ||" }, "PROVIDER_VALUE": { "type": "string", "description": "| Код значения, которое будет взято у провайдера. Возможные значения ключа приведены ниже ||" }, "ORDER": { "type": "string", "description": "| Заказ ||" }, "PROPERTY": { "type": "string", "description": "| Свойства счета ||" }, "PAYMENT": { "type": "string", "description": "| Оплата ||" }, "USER": { "type": "string", "description": "| Пользователь ||" }, "VALUE": { "type": "string", "description": "| Произвольное значение типа строка ||" } }, "required": [ "CODE", "SETTINGS", "CODES" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.delete": { "post": { "summary": "Удалить REST-обработчик платежной системы sale.paysystem.handler.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет REST-обработчик платежной системы.", "operationId": "sale_paysystem_handler_delete", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-handler-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор REST-обработчика ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор REST-обработчика ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.list": { "post": { "summary": "Получить список REST-обработчиков платежной системы sale.paysystem.handler.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает список REST-обработчиков платежной системы.", "operationId": "sale_paysystem_handler_list", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-handler-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Список зарегистрированных REST-обработчиков платежных систем ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Список зарегистрированных REST-обработчиков платежных систем ||" }, "time": { "type": "string", "description": "| Информация о времени выполнения запроса ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.update": { "post": { "summary": "Обновить REST-обработчик платежной системы sale.paysystem.handler.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет REST-обработчик платежной системы.", "operationId": "sale_paysystem_handler_update", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-handler-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор REST-обработчика ||" }, "FIELDS": { "type": "object", "description": "| Набор значений для обновления (подробное описание приведено ниже) ||" }, "CODE": { "type": "string", "description": "| Уникальный код обработчика в системе ||" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика. Формат аналогичен формату в sale.paysystem.handler.add ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор REST-обработчика ||" }, "FIELDS": { "type": "object", "description": "| Набор значений для обновления (подробное описание приведено ниже) ||" }, "CODE": { "type": "string", "description": "| Уникальный код обработчика в системе ||" }, "SETTINGS": { "type": "object", "description": "| Настройки обработчика. Формат аналогичен формату в sale.paysystem.handler.add ||" }, "SORT": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.list": { "post": { "summary": "Получить список платежных систем sale.paysystem.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает список платежных систем.", "operationId": "sale_paysystem_list", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта `sale_paysystem`)." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных платежных систем в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных платежных систем в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта `sale_paysystem`)." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации выбранных платежных систем в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| Объект для сортировки выбранных платежных систем в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.pay.invoice": { "post": { "summary": "Оплатить счет через конкретную платежную систему sale.paysystem.pay.invoice", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод служит для оплаты счета (старая версия) через конкретную платежную систему. Он вызывается после обработки ответа от платежной системы.", "operationId": "sale_paysystem_pay_invoice", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/outdated/sale-pay-system-pay-invoice.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" }, "BX_REST_HANDLER": { "type": "string", "description": "| Символьный идентификатор REST-обработчика платежной системы." } }, "required": [ "INVOICE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" }, "BX_REST_HANDLER": { "type": "string", "description": "| Символьный идентификатор REST-обработчика платежной системы." } }, "required": [ "INVOICE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.pay.payment": { "post": { "summary": "Оплатить заказ через конкретную платежную систему sale.paysystem.pay.payment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод служит для оплаты заказа через конкретную платежную систему. Он вызывается после обработки ответа от платежной системы.", "operationId": "sale_paysystem_pay_payment", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-pay-payment.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Идентификатор оплаты" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Идентификатор оплаты" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.get": { "post": { "summary": "Получить настройки платежной системы sale.paysystem.settings.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает настройки платежной системы. Структура настроек задается при добавлении обработчика платежной системы в методе [sale.paysystem.handler.add](./sale-pay-system-handler-add.md) в ключе `CODES` параметра `SETTINGS`.", "operationId": "sale_paysystem_settings_get", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-settings-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы, для которой нужно получить настройки" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика, для которого нужно получить настройки. Для получения настроек по умолчанию передайте `0`" } }, "required": [ "ID", "PERSON_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы, для которой нужно получить настройки" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика, для которого нужно получить настройки. Для получения настроек по умолчанию передайте `0`" } }, "required": [ "ID", "PERSON_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.invoice.get": { "post": { "summary": "Получить настройки платежной системы для конкретного счета sale.paysystem.settings.invoice.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает настройки платежной системы для конкретного счета (старая версия).", "operationId": "sale_paysystem_settings_invoice_get", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/outdated/sale-pay-system-settings-invoice-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" }, "BX_REST_HANDLER": { "type": "string", "description": "| Символьный идентификатор обработчика платежной системы" } }, "required": [ "INVOICE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" }, "BX_REST_HANDLER": { "type": "string", "description": "| Символьный идентификатор обработчика платежной системы" } }, "required": [ "INVOICE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.payment.get": { "post": { "summary": "Получить настройки платежной системы для конкретной оплаты sale.paysystem.settings.payment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает настройки платежной системы для конкретной оплаты.", "operationId": "sale_paysystem_settings_payment_get", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-settings-payment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Идентификатор оплаты" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Идентификатор оплаты" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Идентификатор платежной системы" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.update": { "post": { "summary": "Обновить настройки платежной системы sale.paysystem.settings.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет настройки платежной системы. Структура настроек задается при добавлении обработчика платежной системы в методе [sale.paysystem.handler.add](./sale-pay-system-handler-add.md) в ключе `CODES` параметра `SETTINGS`.", "operationId": "sale_paysystem_settings_update", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-settings-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы, для которой нужно получить настройки" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика, для которого нужно получить настройки" }, "SETTINGS": { "type": "object", "description": "| Настройки, которые нужно обновить. Ключами выступают названия настроек, значениями — объекты, структура которых описана ниже" }, "TYPE": { "type": "string", "description": "| Источник значения параметра ||" }, "VALUE": { "type": "string", "description": "| Код параметра у источника либо значение параметра (для `TYPE=\"VALUE\"`) ||" } }, "required": [ "ID", "SETTINGS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы, для которой нужно получить настройки" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика, для которого нужно получить настройки" }, "SETTINGS": { "type": "object", "description": "| Настройки, которые нужно обновить. Ключами выступают названия настроек, значениями — объекты, структура которых описана ниже" }, "TYPE": { "type": "string", "description": "| Источник значения параметра ||" }, "VALUE": { "type": "string", "description": "| Код параметра у источника либо значение параметра (для `TYPE=\"VALUE\"`) ||" } }, "required": [ "ID", "SETTINGS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.update": { "post": { "summary": "Изменить платежную систему sale.paysystem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод изменяет платежную систему.", "operationId": "sale_paysystem_update", "tags": [ "Платёжные системы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы ||" }, "FIELDS": { "type": "object", "description": "| Объект, содержащий новые значения полей (подробное описание приведено ниже) ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание платежной системы ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности платежной системы. Возможные значения:" }, "LOGOTYPE": { "type": "string", "description": "| Логотип платежной системы (картинка в формате Base64) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор платежной системы ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор платежной системы ||" }, "FIELDS": { "type": "object", "description": "| Объект, содержащий новые значения полей (подробное описание приведено ниже) ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание платежной системы ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add ||" }, "ACTIVE": { "type": "string", "description": "| Индикатор активности платежной системы. Возможные значения:" }, "LOGOTYPE": { "type": "string", "description": "| Логотип платежной системы (картинка в формате Base64) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор платежной системы ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.persontype.add": { "post": { "summary": "Добавить тип плательщика sale.persontype.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.add` добавляет новый тип плательщика.", "operationId": "sale_persontype_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания нового типа плательщика в виде структуры:" }, "code": { "type": "string", "description": "| Код типа плательщика. Должен быть уникальным ||" }, "sort": { "type": "string", "description": "| Сортировка. По умолчанию значение равно `150` ||" }, "active": { "type": "string", "description": "| Флаг активности. Может принимать значения `Y` / `N`. По умолчанию установлено `Y` ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для создания нового типа плательщика в виде структуры:" }, "code": { "type": "string", "description": "| Код типа плательщика. Должен быть уникальным ||" }, "sort": { "type": "string", "description": "| Сортировка. По умолчанию значение равно `150` ||" }, "active": { "type": "string", "description": "| Флаг активности. Может принимать значения `Y` / `N`. По умолчанию установлено `Y` ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.delete": { "post": { "summary": "Удалить тип плательщика sale.persontype.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.delete` удаляет тип плательщика.", "operationId": "sale_persontype_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа плательщика ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор типа плательщика ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.get": { "post": { "summary": "Получить тип плательщика по Id sale.persontype.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.get` возвращает поля типа плательщика по идентификатору.", "operationId": "sale_persontype_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Номер типа плательщика ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Номер типа плательщика ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.getFields": { "post": { "summary": "Получить поля типа плательщика sale.persontype.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.getFields` возвращает поля типа плательщика.", "operationId": "sale_persontype_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.list": { "post": { "summary": "Получить список типов плательщиков sale.persontype.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.list` получает список типов плательщиков.", "operationId": "sale_persontype_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_person_type)" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных типов плательщиков в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных типов плательщиков в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_person_type)" }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных типов плательщиков в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных типов плательщиков в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.update": { "post": { "summary": "Изменить тип плательщика sale.persontype.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.persontype.update` изменяет поля типа плательщика.", "operationId": "sale_persontype_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/person-type/sale-person-type-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Номер типа плательщика ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления поля типа плательщика в виде структуры:" }, "code": { "type": "string", "description": "| Код типа плательщика. Должен быть уникальным ||" }, "sort": { "type": "string", "description": "| Сортировка. По умолчанию значение равно `150` ||" }, "active": { "type": "string", "description": "| Флаг активности. Может принимать значения `Y` / `N`. По умолчанию установлено `Y` ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Номер типа плательщика ||" }, "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для обновления поля типа плательщика в виде структуры:" }, "code": { "type": "string", "description": "| Код типа плательщика. Должен быть уникальным ||" }, "sort": { "type": "string", "description": "| Сортировка. По умолчанию значение равно `150` ||" }, "active": { "type": "string", "description": "| Флаг активности. Может принимать значения `Y` / `N`. По умолчанию установлено `Y` ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.add": { "post": { "summary": "Добавить свойство заказа sale.property.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.add` добавляет свойство заказа.", "operationId": "sale_property_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания свойства заказа ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "propsGroupId": { "type": "string", "description": "| Идентификатор группы свойств ||" }, "type": { "type": "string", "description": "| Тип свойства заказа." }, "code": { "type": "string", "description": "| Символьный код свойства заказа ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства заказа." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство заказа в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "description": { "type": "string", "description": "| Описание свойства заказа ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства заказа." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства заказа ||" }, "defaultValue": { "type": "string", "description": "| Дефолтное значение свойства заказа." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства заказа." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства заказа ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства заказа ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства заказа." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства.Возможные значения:" }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства заказа ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства заказа ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства заказа ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства заказа в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства заказа. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства заказа. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "fields", "personTypeId", "propsGroupId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания свойства заказа ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "propsGroupId": { "type": "string", "description": "| Идентификатор группы свойств ||" }, "type": { "type": "string", "description": "| Тип свойства заказа." }, "code": { "type": "string", "description": "| Символьный код свойства заказа ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства заказа." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство заказа в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "description": { "type": "string", "description": "| Описание свойства заказа ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства заказа." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства заказа ||" }, "defaultValue": { "type": "string", "description": "| Дефолтное значение свойства заказа." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства заказа." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства заказа ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства заказа ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства заказа." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства.Возможные значения:" }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства заказа ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства заказа ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства заказа ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства заказа в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства заказа. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства заказа. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "fields", "personTypeId", "propsGroupId", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.delete": { "post": { "summary": "Удалить свойство заказа sale.property.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.delete` удаляет свойство заказа.", "operationId": "sale_property_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.get": { "post": { "summary": "Получить свойство заказа sale.property.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.get` получает свойство заказа.", "operationId": "sale_property_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.getfieldsbytype": { "post": { "summary": "Получить поля и настройки свойства заказа для определенного типа свойств sale.property.getfieldsbytype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.getfieldsbytype` получает доступные поля свойств заказа по типу свойств.", "operationId": "sale_property_getfieldsbytype", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-get-fields-by-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип свойства заказа" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип свойства заказа" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.list": { "post": { "summary": "Получить список свойств заказа sale.property.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.list` получает список свойств заказа.", "operationId": "sale_property_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_property)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_property)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.update": { "post": { "summary": "Обновить свойство заказа sale.property.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.property.update` обновляет свойство заказа.", "operationId": "sale_property_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property/sale-property-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" }, "fields": { "type": "object", "description": "| Значения полей для создания свойства заказа ||" }, "code": { "type": "string", "description": "| Символьный код свойства заказа ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства заказа." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство заказа в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "description": { "type": "string", "description": "| Описание свойства заказа ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства заказа." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства заказа ||" }, "defaultValue": { "type": "string", "description": "| Дефолтное значение свойства заказа." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства заказа." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется. ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства заказа ||" }, "fields": { "type": "object", "description": "| Значения полей для создания свойства заказа ||" }, "code": { "type": "string", "description": "| Символьный код свойства заказа ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства заказа." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство заказа в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "description": { "type": "string", "description": "| Описание свойства заказа ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства заказа." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства заказа ||" }, "defaultValue": { "type": "string", "description": "| Дефолтное значение свойства заказа." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства заказа." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется. ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.add": { "post": { "summary": "Добавить привязку свойства sale.propertyRelation.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyRelation.add` добавляет привязку свойства.", "operationId": "sale_propertyRelation_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-relation/sale-property-relation-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки свойства ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта ||" }, "entityType": { "type": "string", "description": "| Тип объекта:" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания привязки свойства ||" }, "entityId": { "type": "integer", "description": "| Идентификатор объекта ||" }, "entityType": { "type": "string", "description": "| Тип объекта:" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.deleteByFilter": { "post": { "summary": "Удалить привязку свойства sale.propertyRelation.deleteByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyRelation.deleteByFilter` удаляет привязку свойства.", "operationId": "sale_propertyRelation_deleteByFilter", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-relation/sale-property-relation-delete-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для удаления привязки свойства ||" }, "entityId": { "type": "integer", "description": "| Идентификатор сущности ||" }, "entityType": { "type": "string", "description": "| Тип сущности:" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для удаления привязки свойства ||" }, "entityId": { "type": "integer", "description": "| Идентификатор сущности ||" }, "entityType": { "type": "string", "description": "| Тип сущности:" }, "propertyId": { "type": "string", "description": "| Идентификатор свойства ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.getFields": { "post": { "summary": "Получить поля привязки свойства sale.propertyRelation.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyRelation.getFields` позволяет получить доступные поля привязки свойства.", "operationId": "sale_propertyRelation_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-relation/sale-property-relation-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.list": { "post": { "summary": "Получить список привязок свойства sale.propertyRelation.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyRelation.list` позволяет получить список привязок свойств.", "operationId": "sale_propertyRelation_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-relation/sale-property-relation-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_relation)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_relation)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.add": { "post": { "summary": "Создать группу свойств sale.propertygroup.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.add` создает группу свойств.", "operationId": "sale_propertygroup_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания группы свойств ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "personTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания группы свойств ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика ||" }, "sort": { "type": "integer", "description": "| Сортировка ||" } }, "required": [ "fields", "personTypeId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.delete": { "post": { "summary": "Удалить группу свойств sale.propertygroup.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.delete` удаляет группу свойств.", "operationId": "sale_propertygroup_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.get": { "post": { "summary": "Получить значения всех полей группы свойств по id sale.propertygroup.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.get` получает значения всех полей группы свойств.", "operationId": "sale_propertygroup_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.getFields": { "post": { "summary": "Получить доступные поля групп свойств sale.propertygroup.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.getFields` получает доступные поля групп свойств.", "operationId": "sale_propertygroup_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.list": { "post": { "summary": "Получить список групп свойств sale.propertygroup.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.list` получает список групп свойств.", "operationId": "sale_propertygroup_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_group)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных групп свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных групп свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_group)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных групп свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных групп свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.update": { "post": { "summary": "Обновить поля группы свойств sale.propertygroup.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertygroup.update` обновляет поля группы свойств.", "operationId": "sale_propertygroup_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-group/sale-property-group-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления группы свойств ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор группы свойств ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления группы свойств ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.delete": { "post": { "summary": "Удалить значение свойства sale.propertyvalue.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvalue.delete` удаляет значения свойства заказа.", "operationId": "sale_propertyvalue_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-value/sale-property-value-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.get": { "post": { "summary": "Получить значение свойства sale.propertyvalue.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvalue.get` получает значение свойства по идентификатору.", "operationId": "sale_propertyvalue_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-value/sale-property-value-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства заказа ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства заказа ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.getfields": { "post": { "summary": "Получить доступные поля значения свойства sale.propertyvalue.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvalue.getfields` возвращает доступные поля вариантов значений свойств заказа.", "operationId": "sale_propertyvalue_getfields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-value/sale-property-value-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.list": { "post": { "summary": "Получить список значений свойств sale.propertyvalue.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvalue.list` получает список вариантов значений свойств заказа.", "operationId": "sale_propertyvalue_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-value/sale-property-value-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_value)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_order_property_value)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.modify": { "post": { "summary": "Изменить значение свойства sale.propertyvalue.modify", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvalue.modify` обновляет значения свойств заказа.", "operationId": "sale_propertyvalue_modify", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-value/sale-property-value-modify.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Корневой элемент, в котором передаются параметры запроса в виде структуры:" }, "order": { "type": "object", "description": "| Объект, содержащий значения идентификатора заказа и значения свойств заказа в виде структуры:" }, "id": { "type": "string", "description": "| Идентификатор заказа ||" }, "propertyValues": { "type": "string", "description": "| Массив объектов (смотрите описание объекта `propertyValues` ниже), содержащих идентификатор свойства заказа и значение свойства ||" }, "orderPropsId": { "type": "string", "description": "| Идентификатор свойства заказа ||" }, "value": { "type": "string", "description": "| Значение свойства заказа." } }, "required": [ "fields", "order", "id", "propertyValues", "orderPropsId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Корневой элемент, в котором передаются параметры запроса в виде структуры:" }, "order": { "type": "object", "description": "| Объект, содержащий значения идентификатора заказа и значения свойств заказа в виде структуры:" }, "id": { "type": "string", "description": "| Идентификатор заказа ||" }, "propertyValues": { "type": "string", "description": "| Массив объектов (смотрите описание объекта `propertyValues` ниже), содержащих идентификатор свойства заказа и значение свойства ||" }, "orderPropsId": { "type": "string", "description": "| Идентификатор свойства заказа ||" }, "value": { "type": "string", "description": "| Значение свойства заказа." } }, "required": [ "fields", "order", "id", "propertyValues", "orderPropsId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.add": { "post": { "summary": "Добавить вариант свойства sale.propertyvariant.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.add` добавляет вариант значения в свойство заказа типа `ENUM`.", "operationId": "sale_propertyvariant_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового варианта (подробное описание) ||" }, "orderPropsId": { "type": "string", "description": "| Идентификатор свойства заказа типа `ENUM`. Получить его можно методом sale.property.list с фильтром `{\"type\": \"ENUM\"}` ||" }, "value": { "type": "string", "description": "| Символьный код варианта. Сохраняется в заказе как значение свойства. Метод не проверяет уникальность кода внутри свойства ||" }, "sort": { "type": "integer", "description": "| Порядок вывода варианта в списке. По умолчанию `100` ||" }, "description": { "type": "string", "description": "| Описание варианта ||" } }, "required": [ "fields", "orderPropsId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового варианта (подробное описание) ||" }, "orderPropsId": { "type": "string", "description": "| Идентификатор свойства заказа типа `ENUM`. Получить его можно методом sale.property.list с фильтром `{\"type\": \"ENUM\"}` ||" }, "value": { "type": "string", "description": "| Символьный код варианта. Сохраняется в заказе как значение свойства. Метод не проверяет уникальность кода внутри свойства ||" }, "sort": { "type": "integer", "description": "| Порядок вывода варианта в списке. По умолчанию `100` ||" }, "description": { "type": "string", "description": "| Описание варианта ||" } }, "required": [ "fields", "orderPropsId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.delete": { "post": { "summary": "Удалить вариант свойства sale.propertyvariant.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.delete` удаляет вариант значения свойства заказа. В заказах, где этот вариант уже выбран, сохраненное значение свойства не меняется.", "operationId": "sale_propertyvariant_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.get": { "post": { "summary": "Получить вариант значения свойства по id sale.propertyvariant.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.get` возвращает вариант значения свойства заказа по идентификатору.", "operationId": "sale_propertyvariant_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.getFields": { "post": { "summary": "Получить доступные поля варианта свойства sale.propertyvariant.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.getFields` возвращает поля варианта значения свойства с типом и признаками обязательности и изменяемости.", "operationId": "sale_propertyvariant_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.list": { "post": { "summary": "Получить список вариантов свойств sale.propertyvariant.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.list` возвращает список вариантов значений свойств заказа. Чтобы получить варианты одного свойства, передайте в `filter` его `orderPropsId`.", "operationId": "sale_propertyvariant_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Поля варианта, которые нужно вернуть: `id`, `orderPropsId`, `name`, `value`, `sort`, `description`. Описание полей." }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля: `id`, `orderPropsId`, `name`, `value`, `sort`, `description`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает до 50 записей за вызов. Чтобы получить страницу N, передайте `start` = `(N-1) * 50`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Поля варианта, которые нужно вернуть: `id`, `orderPropsId`, `name`, `value`, `sort`, `description`. Описание полей." }, "filter": { "type": "object", "description": "| Фильтр в формате `{\"поле\": \"значение\"}`. Доступные поля: `id`, `orderPropsId`, `name`, `value`, `sort`, `description`." }, "order": { "type": "object", "description": "| Сортировка в формате `{\"поле\": \"направление\"}`. Поля те же, что в `filter`. Направление:" }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает до 50 записей за вызов. Чтобы получить страницу N, передайте `start` = `(N-1) * 50`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.update": { "post": { "summary": "Обновить поля варианта свойства sale.propertyvariant.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.propertyvariant.update` изменяет название, код, порядок и описание варианта значения свойства заказа.", "operationId": "sale_propertyvariant_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/property-variant/sale-property-variant-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" }, "fields": { "type": "object", "description": "| Поля варианта (подробное описание)." }, "value": { "type": "string", "description": "| Символьный код варианта. Передайте текущий код, если не меняете его. Получить текущие значения можно методом sale.propertyvariant.get ||" }, "sort": { "type": "integer", "description": "| Порядок вывода варианта в списке ||" }, "description": { "type": "string", "description": "| Описание варианта. Чтобы очистить описание, передайте пустую строку ||" } }, "required": [ "id", "fields", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор варианта. Получить его можно методом sale.propertyvariant.list ||" }, "fields": { "type": "object", "description": "| Поля варианта (подробное описание)." }, "value": { "type": "string", "description": "| Символьный код варианта. Передайте текущий код, если не меняете его. Получить текущие значения можно методом sale.propertyvariant.get ||" }, "sort": { "type": "integer", "description": "| Порядок вывода варианта в списке ||" }, "description": { "type": "string", "description": "| Описание варианта. Чтобы очистить описание, передайте пустую строку ||" } }, "required": [ "id", "fields", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.add": { "post": { "summary": "Добавить отгрузку sale.shipment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.add` добавляет отгрузку.", "operationId": "sale_shipment_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания отгрузки ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "allowDelivery": { "type": "string", "description": "| Признак разрешения доставки" }, "deducted": { "type": "string", "description": "| Признак того, является ли отгрузка отгруженной" }, "deliveryId": { "type": "string", "description": "| Идентификатор службы доставки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса доставки" }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Дата документа отгрузки ||" }, "deliveryDocNum": { "type": "string", "description": "| Номер документа отгрузки ||" }, "trackingNumber": { "type": "string", "description": "| Идентификатор отправления ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Базовая стоимость доставки (без скидок / наценок)." }, "comments": { "type": "string", "description": "| Комментарий менеджера ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин»." }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за отгрузку ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор отгрузки." } }, "required": [ "fields", "orderId", "allowDelivery", "deducted", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания отгрузки ||" }, "orderId": { "type": "string", "description": "| Идентификатор заказа ||" }, "allowDelivery": { "type": "string", "description": "| Признак разрешения доставки" }, "deducted": { "type": "string", "description": "| Признак того, является ли отгрузка отгруженной" }, "deliveryId": { "type": "string", "description": "| Идентификатор службы доставки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса доставки" }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Дата документа отгрузки ||" }, "deliveryDocNum": { "type": "string", "description": "| Номер документа отгрузки ||" }, "trackingNumber": { "type": "string", "description": "| Идентификатор отправления ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Базовая стоимость доставки (без скидок / наценок)." }, "comments": { "type": "string", "description": "| Комментарий менеджера ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин»." }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя, ответственного за отгрузку ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор отгрузки." } }, "required": [ "fields", "orderId", "allowDelivery", "deducted", "deliveryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.delete": { "post": { "summary": "Удалить отгрузку sale.shipment.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.delete` удаляет отгрузку.", "operationId": "sale_shipment_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.get": { "post": { "summary": "Получить поля отгрузки sale.shipment.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.get` получает значения всех полей отгрузки.", "operationId": "sale_shipment_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.getFields": { "post": { "summary": "Получить доступные поля отгрузки sale.shipment.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.getFields` получает доступные поля отгрузки.", "operationId": "sale_shipment_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.list": { "post": { "summary": "Получить список отгрузок sale.shipment.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.list` получает список отгрузок.", "operationId": "sale_shipment_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_shipment)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных привязок оплат к отгрузкам в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.update": { "post": { "summary": "Обновить отгрузку sale.shipment.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipment.update` обновляет отгрузку.", "operationId": "sale_shipment_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment/sale-shipment-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления отгрузки ||" }, "allowDelivery": { "type": "string", "description": "| Признак разрешения доставки." }, "deducted": { "type": "string", "description": "| Признак того, является ли отгрузка отгруженной." }, "deliveryId": { "type": "string", "description": "| Идентификатор службы доставки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса доставки." }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Дата документа отгрузки ||" }, "deliveryDocNum": { "type": "string", "description": "| Номер документа отгрузки ||" }, "trackingNumber": { "type": "string", "description": "| Идентификатор отправления ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Базовая стоимость доставки (без скидок / наценок)." }, "priceDelivery": { "type": "number", "format": "double", "description": "| Стоимость доставки." }, "comments": { "type": "string", "description": "| Комментарий менеджера ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин»." }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя ответственного за отгрузку ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор отгрузки." } }, "required": [ "id", "fields", "allowDelivery", "deducted", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления отгрузки ||" }, "allowDelivery": { "type": "string", "description": "| Признак разрешения доставки." }, "deducted": { "type": "string", "description": "| Признак того, является ли отгрузка отгруженной." }, "deliveryId": { "type": "string", "description": "| Идентификатор службы доставки ||" }, "statusId": { "type": "string", "description": "| Идентификатор статуса доставки." }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Дата документа отгрузки ||" }, "deliveryDocNum": { "type": "string", "description": "| Номер документа отгрузки ||" }, "trackingNumber": { "type": "string", "description": "| Идентификатор отправления ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Базовая стоимость доставки (без скидок / наценок)." }, "priceDelivery": { "type": "number", "format": "double", "description": "| Стоимость доставки." }, "comments": { "type": "string", "description": "| Комментарий менеджера ||" }, "companyId": { "type": "integer", "description": "| Идентификатор компании из модуля «Интернет-магазин»." }, "responsibleId": { "type": "string", "description": "| Идентификатор пользователя ответственного за отгрузку ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор отгрузки." } }, "required": [ "id", "fields", "allowDelivery", "deducted", "deliveryId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.add": { "post": { "summary": "Добавить элемент в табличную часть отгрузки sale.shipmentitem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.add` добавляет товар из позиции корзины в отгрузку. Позиция корзины и отгрузка должны принадлежать одному заказу. Правила распределения количества между отгрузками — в [обзоре раздела](./index.md#quantity).", "operationId": "sale_shipmentitem_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания элемента табличной части отгрузки (подробное описание) ||" }, "orderDeliveryId": { "type": "string", "description": "| Идентификатор отгрузки." }, "basketId": { "type": "string", "description": "| Идентификатор позиции корзины." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара в отгрузке. Должно быть больше `0`." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор. Если не передан, Битрикс24 генерирует значение вида `bx_6abcd8337a3d4`." } }, "required": [ "fields", "orderDeliveryId", "basketId", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания элемента табличной части отгрузки (подробное описание) ||" }, "orderDeliveryId": { "type": "string", "description": "| Идентификатор отгрузки." }, "basketId": { "type": "string", "description": "| Идентификатор позиции корзины." }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара в отгрузке. Должно быть больше `0`." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор. Если не передан, Битрикс24 генерирует значение вида `bx_6abcd8337a3d4`." } }, "required": [ "fields", "orderDeliveryId", "basketId", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.delete": { "post": { "summary": "Удалить элемент табличной части отгрузки sale.shipmentitem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.delete` удаляет элемент табличной части отгрузки — убирает товар из отгрузки. Позиция корзины при этом остается в заказе, а количество товара возвращается в системную отгрузку. Элементы системной отгрузки и отгрузки с `deducted` = `Y` удалить нельзя.", "operationId": "sale_shipmentitem_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.get": { "post": { "summary": "Получить элемент табличной части отгрузки sale.shipmentitem.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.get` возвращает элемент табличной части отгрузки по идентификатору: позицию корзины, отгрузку и количество товара. Для элемента системной отгрузки, в которой числится нераспределенный товар заказа, метод возвращает пустой массив без ошибки — состав системной отгрузки получайте методом [sale.shipmentitem.list](./sale-shipment-item-list.md).", "operationId": "sale_shipmentitem_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.getFields": { "post": { "summary": "Получить поля элемента табличной части отгрузки sale.shipmentitem.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.getFields` возвращает описание полей элемента табличной части отгрузки: тип поля, обязательность, доступность для записи. По ответу видно, какие поля передавать в [sale.shipmentitem.add](./sale-shipment-item-add.md) и [sale.shipmentitem.update](./sale-shipment-item-update.md): поле с `isReadOnly: true` не записывается, а поле с `isImmutable: true` задается только при добавлении.", "operationId": "sale_shipmentitem_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.list": { "post": { "summary": "Получить список элементов табличной части отгрузки sale.shipmentitem.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.list` возвращает элементы табличных частей отгрузок: какие позиции корзины и в каком количестве входят в отгрузку.", "operationId": "sale_shipmentitem_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Доступные поля — в объекте sale_order_shipment_item." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей. По умолчанию `0` — первая страница." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Доступные поля — в объекте sale_order_shipment_item." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей. По умолчанию `0` — первая страница." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.update": { "post": { "summary": "Изменить элемент в табличной части отгрузки sale.shipmentitem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentitem.update` изменяет количество товара и внешний идентификатор элемента табличной части отгрузки.", "operationId": "sale_shipmentitem_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-item/sale-shipment-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." }, "fields": { "type": "object", "description": "| Значения полей для обновления элемента табличной части отгрузки (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара в отгрузке. Должно быть больше `0`." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор. Если поле не передано, прежнее значение сохраняется." } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор элемента табличной части отгрузки." }, "fields": { "type": "object", "description": "| Значения полей для обновления элемента табличной части отгрузки (подробное описание) ||" }, "quantity": { "type": "number", "format": "double", "description": "| Количество товара в отгрузке. Должно быть больше `0`." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор. Если поле не передано, прежнее значение сохраняется." } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.add": { "post": { "summary": "Добавить свойство отгрузки sale.shipmentproperty.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.add` добавляет свойство отгрузки.", "operationId": "sale_shipmentproperty_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания свойства отгрузки ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика." }, "propsGroupId": { "type": "string", "description": "| Идентификатор группы свойств. Группа должна относиться к типу плательщика из `personTypeId`." }, "type": { "type": "string", "description": "| Тип свойства отгрузки. Изменить тип после создания нельзя." }, "code": { "type": "string", "description": "| Символьный код свойства отгрузки. Если не передан, код остается пустым ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства отгрузки." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки служебным. Служебные свойства отгрузки не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство отгрузки в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство отгрузки в фильтре на странице списка отгрузок." }, "sort": { "type": "integer", "description": "| Порядок сортировки свойства. Если не передано, по умолчанию `100` ||" }, "description": { "type": "string", "description": "| Описание свойства отгрузки ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства отгрузки." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства отгрузки. Если не передан, создается автоматически в формате `bx_<строка>` ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства отгрузки по умолчанию." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства отгрузки." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства отгрузки." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства." }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства отгрузки ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства отгрузки ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства отгрузки ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства отгрузки в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства отгрузки. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства отгрузки. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "fields", "personTypeId", "propsGroupId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания свойства отгрузки ||" }, "personTypeId": { "type": "string", "description": "| Идентификатор типа плательщика." }, "propsGroupId": { "type": "string", "description": "| Идентификатор группы свойств. Группа должна относиться к типу плательщика из `personTypeId`." }, "type": { "type": "string", "description": "| Тип свойства отгрузки. Изменить тип после создания нельзя." }, "code": { "type": "string", "description": "| Символьный код свойства отгрузки. Если не передан, код остается пустым ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства отгрузки." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки служебным. Служебные свойства отгрузки не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство отгрузки в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство отгрузки в фильтре на странице списка отгрузок." }, "sort": { "type": "integer", "description": "| Порядок сортировки свойства. Если не передано, по умолчанию `100` ||" }, "description": { "type": "string", "description": "| Описание свойства отгрузки ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства отгрузки." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства отгрузки. Если не передан, создается автоматически в формате `bx_<строка>` ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства отгрузки по умолчанию." }, "settings": { "type": "object", "description": "| Объект в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` для передачи дополнительных настроек свойства отгрузки." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства отгрузки." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства." }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства отгрузки ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства отгрузки ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства отгрузки ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства отгрузки в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства отгрузки. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства отгрузки. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "fields", "personTypeId", "propsGroupId", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.delete": { "post": { "summary": "Удалить свойство отгрузки sale.shipmentproperty.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.delete` удаляет свойство отгрузки.", "operationId": "sale_shipmentproperty_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.get": { "post": { "summary": "Получить свойство отгрузки sale.shipmentproperty.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.get` получает свойство отгрузки.", "operationId": "sale_shipmentproperty_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.getfieldsbytype": { "post": { "summary": "Получить поля и настройки свойства отгрузки для определенного типа свойств sale.shipmentproperty.getfieldsbytype", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.getfieldsbytype` получает доступные поля свойств отгрузки по типу свойств.", "operationId": "sale_shipmentproperty_getfieldsbytype", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-get-fields-by-type.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип свойства отгрузки." } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Тип свойства отгрузки." } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.list": { "post": { "summary": "Получить список свойств отгрузки sale.shipmentproperty.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.list` получает список свойств отгрузки.", "operationId": "sale_shipmentproperty_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных свойств отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных свойств отгрузки в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.update": { "post": { "summary": "Обновить свойство отгрузки sale.shipmentproperty.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentproperty.update` обновляет свойство отгрузки.", "operationId": "sale_shipmentproperty_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property/sale-shipment-property-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления свойства отгрузки." }, "code": { "type": "string", "description": "| Символьный код свойства отгрузки ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства отгрузки." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки служебным. Служебные свойства отгрузки не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство отгрузки в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство отгрузки в фильтре на странице списка отгрузок." }, "sort": { "type": "integer", "description": "| Порядок сортировки свойства. Если не передано, значение сбрасывается в `100` ||" }, "description": { "type": "string", "description": "| Описание свойства отгрузки ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства отгрузки." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства отгрузки ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства отгрузки по умолчанию." }, "settings": { "type": "object", "description": "| Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"} для передачи дополнительных настроек свойства отгрузки." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства отгрузки." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства." }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства отгрузки ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства отгрузки ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства отгрузки ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства отгрузки в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства отгрузки. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства отгрузки. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор свойства отгрузки ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления свойства отгрузки." }, "code": { "type": "string", "description": "| Символьный код свойства отгрузки ||" }, "active": { "type": "string", "description": "| Индикатор активности свойства отгрузки." }, "util": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки служебным. Служебные свойства отгрузки не отображаются в публичной части." }, "userProps": { "type": "string", "description": "| Индикатор, входит ли свойство отгрузки в профиль покупателя." }, "isFiltered": { "type": "string", "description": "| Индикатор, доступно ли свойство отгрузки в фильтре на странице списка отгрузок." }, "sort": { "type": "integer", "description": "| Порядок сортировки свойства. Если не передано, значение сбрасывается в `100` ||" }, "description": { "type": "string", "description": "| Описание свойства отгрузки ||" }, "required": { "type": "string", "description": "| Индикатор обязательности заполнения значения свойства отгрузки." }, "multiple": { "type": "string", "description": "| Индикатор, является ли свойство отгрузки множественным. Для множественных свойств возможно указать несколько значений." }, "xmlId": { "type": "string", "description": "| Внешний идентификатор свойства отгрузки ||" }, "defaultValue": { "type": "string", "description": "| Значение свойства отгрузки по умолчанию." }, "settings": { "type": "object", "description": "| Объект в формате {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"} для передачи дополнительных настроек свойства отгрузки." }, "isProfileName": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве названия профиля пользователя." }, "isPayer": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве имени плательщика." }, "isEmail": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа)." }, "isPhone": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве номера телефона." }, "isZip": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве почтового индекса." }, "isAddress": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса." }, "isLocation": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для расчета стоимости доставки." }, "isLocation4tax": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве местоположения покупателя для определения ставок налогов." }, "inputFieldLocation": { "type": "string", "description": "| Устаревшее поле. Не используется ||" }, "isAddressFrom": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки." }, "isAddressTo": { "type": "string", "description": "| Индикатор необходимости использования значения данного свойства отгрузки в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки." }, "minlength": { "type": "integer", "description": "| Минимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "maxlength": { "type": "integer", "description": "| Максимально допустимая длина (кол-во символов) значения свойства отгрузки ||" }, "pattern": { "type": "string", "description": "| Регулярное выражение для проверки значения свойства отгрузки." }, "multiline": { "type": "string", "description": "| Индикатор необходимости отображения многострочного поля для ввода значения свойства." }, "cols": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "rows": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "size": { "type": "integer", "description": "| Устаревший параметр. Не используется ||" }, "min": { "type": "integer", "description": "| Минимально допустимое значение для данного свойства отгрузки ||" }, "max": { "type": "integer", "description": "| Максимально допустимое значение для данного свойства отгрузки ||" }, "step": { "type": "integer", "description": "| Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства отгрузки ||" }, "multielement": { "type": "string", "description": "| Индикатор необходимости отображения свойства отгрузки в виде списка чекбоксов." }, "maxsize": { "type": "integer", "description": "| Максимально допустимый размер загружаемого файла в байтах ||" }, "accept": { "type": "string", "description": "| Список расширений файлов, которые допустимо загружать в значение данного свойства отгрузки. Пример: png, doc, zip ||" }, "time": { "type": "string", "description": "| Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства отгрузки. Значение используется в некоторых пользовательских интерфейсах." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.delete": { "post": { "summary": "Удалить значения свойства отгрузки sale.shipmentpropertyvalue.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentpropertyvalue.delete` удаляет значения свойства отгрузки.", "operationId": "sale_shipmentpropertyvalue_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-propertyvalue-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства отгрузки ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства отгрузки ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.get": { "post": { "summary": "Получить значения свойства отгрузки по id sale.shipmentpropertyvalue.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentpropertyvalue.get` возвращает значения свойства отгрузки.", "operationId": "sale_shipmentpropertyvalue_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-property-value-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства отгрузки ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор значения свойства отгрузки ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.getFields": { "post": { "summary": "Получить доступные поля значений свойств отгрузки sale.shipmentpropertyvalue.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentpropertyvalue.getFields` возвращает доступные поля значений свойств отгрузки.", "operationId": "sale_shipmentpropertyvalue_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-property-value-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.list": { "post": { "summary": "Получить список значений свойств отгрузки sale.shipmentpropertyvalue.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentpropertyvalue.list` возвращает список значений свойств отгрузки.", "operationId": "sale_shipmentpropertyvalue_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-property-value-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_shipment_property_value)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_shipment_property_value)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных значений свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных значений свойств в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.modify": { "post": { "summary": "Обновить значения свойств отгрузки sale.shipmentpropertyvalue.modify", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.shipmentpropertyvalue.modify` обновляет значения свойств отгрузки.", "operationId": "sale_shipmentpropertyvalue_modify", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/shipment-property-value/sale-shipment-property-value-modify.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Корневой элемент, в котором передаются параметры запроса ||" }, "shipment": { "type": "object", "description": "| Объект, содержащий значения идентификатора отгрузки и значения свойств отгрузки (подробное описание приведено ниже) ||" }, "id": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "propertyValues": { "type": "string", "description": "| Массив объектов, содержащих идентификатор свойства отгрузки и значение свойства (подробное описание приведено ниже) ||" }, "shipmentPropsId": { "type": "string", "description": "| Идентификатор свойства отгрузки ||" }, "value": { "type": "string", "description": "| Значение свойства ||" } }, "required": [ "fields", "shipment", "id", "propertyValues", "shipmentPropsId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Корневой элемент, в котором передаются параметры запроса ||" }, "shipment": { "type": "object", "description": "| Объект, содержащий значения идентификатора отгрузки и значения свойств отгрузки (подробное описание приведено ниже) ||" }, "id": { "type": "string", "description": "| Идентификатор отгрузки ||" }, "propertyValues": { "type": "string", "description": "| Массив объектов, содержащих идентификатор свойства отгрузки и значение свойства (подробное описание приведено ниже) ||" }, "shipmentPropsId": { "type": "string", "description": "| Идентификатор свойства отгрузки ||" }, "value": { "type": "string", "description": "| Значение свойства ||" } }, "required": [ "fields", "shipment", "id", "propertyValues", "shipmentPropsId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.add": { "post": { "summary": "Создать статус sale.status.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.add` создает статус заказа или доставки.", "operationId": "sale_status_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания статуса ||" }, "id": { "type": "string", "description": "| Символьный идентификатор статуса." }, "type": { "type": "string", "description": "| Тип статуса:" }, "notify": { "type": "string", "description": "| Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "color": { "type": "string", "description": "| HEX-код цвета статуса (например, `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| Внешний код статуса." } }, "required": [ "fields", "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для создания статуса ||" }, "id": { "type": "string", "description": "| Символьный идентификатор статуса." }, "type": { "type": "string", "description": "| Тип статуса:" }, "notify": { "type": "string", "description": "| Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "color": { "type": "string", "description": "| HEX-код цвета статуса (например, `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| Внешний код статуса." } }, "required": [ "fields", "id", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.delete": { "post": { "summary": "Удалить статус sale.status.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.delete` удаляет статус заказа или доставки.", "operationId": "sale_status_delete", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор статуса ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор статуса ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.get": { "post": { "summary": "Получить значения всех полей статуса по id sale.status.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.get` получает значения всех полей статуса.", "operationId": "sale_status_get", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор статуса ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор статуса ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.getFields": { "post": { "summary": "Получить доступные поля статусов sale.status.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.getFields` возвращает доступные поля статусов.", "operationId": "sale_status_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.list": { "post": { "summary": "Получить список статусов sale.status.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.list` получает список статусов.", "operationId": "sale_status_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_status)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных групп свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных статусов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_status)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных групп свойств в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных статусов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.update": { "post": { "summary": "Обновить статус sale.status.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.status.update` обновляет статус заказа или доставки.", "operationId": "sale_status_update", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления статуса ||" }, "type": { "type": "string", "description": "| Тип статуса:" }, "notify": { "type": "string", "description": "| Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "color": { "type": "string", "description": "| HEX-код цвета статуса (например, `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| Внешний код статуса." } }, "required": [ "id", "fields", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления статуса ||" }, "type": { "type": "string", "description": "| Тип статуса:" }, "notify": { "type": "string", "description": "| Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус." }, "sort": { "type": "integer", "description": "| Сортировка ||" }, "color": { "type": "string", "description": "| HEX-код цвета статуса (например, `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| Внешний код статуса." } }, "required": [ "id", "fields", "type" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.add": { "post": { "summary": "Добавить локализацию sale.statusLang.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.statusLang.add` добавляет локализацию статуса заказа или доставки.", "operationId": "sale_statusLang_add", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status-lang/sale-status-lang-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления локализации статуса в виде структуры:" }, "statusId": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "lid": { "type": "string", "description": "| Идентификатор языка. Текущие возможные значения приведены ниже:" }, "description": { "type": "string", "description": "| Описание статуса для создаваемой локализации ||" } }, "required": [ "fields", "statusId", "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей (подробное описание приведено ниже) для добавления локализации статуса в виде структуры:" }, "statusId": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "lid": { "type": "string", "description": "| Идентификатор языка. Текущие возможные значения приведены ниже:" }, "description": { "type": "string", "description": "| Описание статуса для создаваемой локализации ||" } }, "required": [ "fields", "statusId", "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.deleteByFilter": { "post": { "summary": "Удалить локализацию sale.statusLang.deleteByFilter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.statusLang.deleteByFilter` удаляет записи локализации статуса заказа или доставки по идентификатору статуса и языку.", "operationId": "sale_statusLang_deleteByFilter", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status-lang/sale-status-lang-delete-by-filter.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей фильтра (подробное описание приведено ниже) для удаления записи локализации в виде структуры:" }, "statusId": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "lid": { "type": "string", "description": "| Идентификатор языка. Текущие возможные значения приведены ниже:" } }, "required": [ "fields", "statusId", "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей фильтра (подробное описание приведено ниже) для удаления записи локализации в виде структуры:" }, "statusId": { "type": "string", "description": "| Символьный идентификатор статуса ||" }, "lid": { "type": "string", "description": "| Идентификатор языка. Текущие возможные значения приведены ниже:" } }, "required": [ "fields", "statusId", "lid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.getFields": { "post": { "summary": "Получить поля локализации статусов sale.statusLang.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.statusLang.getFields` получает доступные поля локализаций статусов заказа или доставки.", "operationId": "sale_statusLang_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status-lang/sale-status-lang-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.getListLangs": { "post": { "summary": "Получить список языков для локализации sale.statusLang.getListLangs", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.statusLang.getListLangs` получает список возможных языков для локализаций.", "operationId": "sale_statusLang_getListLangs", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status-lang/sale-status-lang-get-list-langs.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.list": { "post": { "summary": "Получить список локализаций статусов sale.statusLang.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.statusLang.list` получает список локализаций статусов заказа или доставки.", "operationId": "sale_statusLang_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/status-lang/sale-status-lang-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_status_lang)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных статусов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_status_lang)." }, "filter": { "type": "object", "description": "| Объект для фильтрации выбранных элементов табличной части отгрузки в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Объект для сортировки выбранных статусов в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradeBinding.getFields": { "post": { "summary": "Получить поля привязки заказа к источнику sale.tradeBinding.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.tradeBinding.getFields` возвращает поля привязки заказа к источнику, которые можно передавать в `select`, `filter` и `order` метода [sale.tradeBinding.list](./sale-trade-binding-list.md).", "operationId": "sale_tradeBinding_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/trade-binding/sale-trade-binding-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradeBinding.list": { "post": { "summary": "Получить список привязок заказов к источникам sale.tradeBinding.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.tradeBinding.list` возвращает привязки заказов к источникам без состава заказа — состав получите методом [sale.order.get](../order/sale-order-get.md).", "operationId": "sale_tradeBinding_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/trade-binding/sale-trade-binding-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Доступные поля — в объекте sale_order_trade_binding." }, "filter": { "type": "object", "description": "| Объект для фильтрации привязок в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. При указании нескольких полей используется логика AND." }, "order": { "type": "object", "description": "| Объект для сортировки привязок в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей. По умолчанию `0` — первая страница." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть. Доступные поля — в объекте sale_order_trade_binding." }, "filter": { "type": "object", "description": "| Объект для фильтрации привязок в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. При указании нескольких полей используется логика AND." }, "order": { "type": "object", "description": "| Объект для сортировки привязок в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Размер страницы — 50 записей. По умолчанию `0` — первая страница." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradePlatform.getFields": { "post": { "summary": "Получить доступные поля источников заказов sale.tradePlatform.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.tradePlatform.getFields` возвращает доступные поля источников заказов.", "operationId": "sale_tradePlatform_getFields", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/trade-platform/sale-trade-platform-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradePlatform.list": { "post": { "summary": "Получить список источников заказов sale.tradePlatform.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sale.tradePlatform.list` получает список источников заказов.", "operationId": "sale_tradePlatform_list", "tags": [ "Интернет-магазин" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sale/trade-platform/sale-trade-platform-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_trade_platform) ||" }, "filter": { "type": "object", "description": "| Список полей для фильтрации. При указании нескольких полей используется логика AND." }, "order": { "type": "object", "description": "| Параметры сортировки. Формат: `{поле: направление (ASC, DESC)}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_order_trade_platform) ||" }, "filter": { "type": "object", "description": "| Список полей для фильтрации. При указании нескольких полей используется логика AND." }, "order": { "type": "object", "description": "| Параметры сортировки. Формат: `{поле: направление (ASC, DESC)}`." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/salescenter.payment.getPublicUrl": { "post": { "summary": "Сгенерировать ссылку на определенную оплату salescenter.payment.getPublicUrl", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `salescenter.payment.getPublicUrl` возвращает публичную ссылку на страницу оплаты, короткую ссылку и QR-код с короткой ссылкой. Способ оплаты, который клиент выберет на странице, запишется в эту оплату.", "operationId": "salescenter_payment_getPublicUrl", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/payment/salescenter-payment-get-public-url.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "options": { "type": "object", "description": "| Настройки QR-кода. Поддерживается один ключ `qr` (подробное описание) ||" }, "w": { "type": "integer", "description": "| Ширина изображения в пикселях ||" }, "h": { "type": "integer", "description": "| Высота изображения в пикселях ||" }, "p": { "type": "integer", "description": "| Отступ вокруг QR-кода в пикселях ||" }, "wq": { "type": "integer", "description": "| Ширина свободной зоны вокруг QR-кода в модулях ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list ||" }, "options": { "type": "object", "description": "| Настройки QR-кода. Поддерживается один ключ `qr` (подробное описание) ||" }, "w": { "type": "integer", "description": "| Ширина изображения в пикселях ||" }, "h": { "type": "integer", "description": "| Высота изображения в пикселях ||" }, "p": { "type": "integer", "description": "| Отступ вокруг QR-кода в пикселях ||" }, "wq": { "type": "integer", "description": "| Ширина свободной зоны вокруг QR-кода в модулях ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "salescenter" ] } ] } }, "/server.time": { "post": { "summary": "Получить текущее время сервера server.time", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `server.time` возвращает текущее время сервера Битрикс24 в формате ISO 8601 `YYYY-MM-DDThh:mm:ss±hh:mm`.", "operationId": "server_time", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/system/server-time.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/sign.b2e.company.provider.list": { "post": { "summary": "Получить список провайдеров компании sign.b2e.company.provider.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.company.provider.list` возвращает список провайдеров подписи для выбранной компании.", "operationId": "sign_b2e_company_provider_list", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-company-provider-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "companyUuid": { "type": "string", "description": "| UUID компании в HCM Link." }, "companyCrmId": { "type": "integer", "description": "| Идентификатор компании в CRM, подключенный в интеграции как «моя компания»." }, "language": { "type": "string", "description": "| Язык названий провайдеров. Код языка интерфейса Битрикс24, например `ru` или `en`." }, "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько провайдеров пропустить от начала списка. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } }, "required": [ "companyUuid", "companyCrmId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "companyUuid": { "type": "string", "description": "| UUID компании в HCM Link." }, "companyCrmId": { "type": "integer", "description": "| Идентификатор компании в CRM, подключенный в интеграции как «моя компания»." }, "language": { "type": "string", "description": "| Язык названий провайдеров. Код языка интерфейса Битрикс24, например `ru` или `en`." }, "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько провайдеров пропустить от начала списка. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } }, "required": [ "companyUuid", "companyCrmId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.document.get": { "post": { "summary": "Получить документ sign.b2e.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.document.get` возвращает информацию о документе и участниках подписания.", "operationId": "sign_b2e_document_get", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uid": { "type": "string", "description": "| Уникальный идентификатор документа." }, "language": { "type": "string", "description": "| Язык названий статусов в ответе. Код языка интерфейса Битрикс24, например `ru` или `en`." } }, "required": [ "uid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "uid": { "type": "string", "description": "| Уникальный идентификатор документа." }, "language": { "type": "string", "description": "| Язык названий статусов в ответе. Код языка интерфейса Битрикс24, например `ru` или `en`." } }, "required": [ "uid" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.document.send": { "post": { "summary": "Отправить документ на подписание sign.b2e.document.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.document.send` отправляет документ на подписание со стороны компании.", "operationId": "sign_b2e_document_send", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-document-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Параметры отправки документа на подписание (подробное описание) ||" }, "language": { "type": "string", "description": "| Язык названий статусов в ответе. Код языка интерфейса Битрикс24, например `ru` или `en`." }, "company": { "type": "object", "description": "| Компания, от имени которой отправляется документ (подробное описание) ||" }, "members": { "type": "array", "items": {}, "description": "| Список участников подписания. Должен содержать минимум одного участника с ролью `signer` и одного с ролью `assignee` (подробное описание) ||" }, "responsible": { "type": "object", "description": "| Ответственный за документ (подробное описание) ||" }, "companyProviderUid": { "type": "string", "description": "| Идентификатор провайдера подписи. Получить список доступных провайдеров подписи можно методом sign.b2e.company.provider.list ||" }, "files": { "type": "array", "items": {}, "description": "| Файл подписываемого документа (подробное описание) ||" }, "regionDocumentType": { "type": "string", "description": "| Тип документа для региона (подробное описание) ||" }, "externalSettings": { "type": "object", "description": "| Внешние параметры документа (подробное описание) ||" }, "message": { "type": "string", "description": "| Текст сообщения для сотрудника. Сотрудник увидит сообщение в чате вместе с приглашением подписать документ." }, "uuid": { "type": "string", "description": "| UUID компании в HCM Link." }, "crmId": { "type": "integer", "description": "| Идентификатор компании в CRM, подключенный в интеграции как «моя компания» ||" }, "employeeCode": { "type": "string", "description": "| Код сотрудника в HCM Link." }, "employeeId": { "type": "integer", "description": "| Идентификатор сотрудника в HCM Link." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя в Битрикс24 ||" }, "role": { "type": "string", "description": "| Роль участника. Возможные значения:" }, "fileName": { "type": "string", "description": "| Имя файла. Обязательно с расширением `.pdf` ||" }, "fileType": { "type": "string", "description": "| MIME-тип файла. Поддерживается `application/pdf` ||" }, "fileContent": { "type": "string", "description": "| Содержимое файла, закодированное в Base64 ||" }, "externalId": { "type": "string", "description": "| Внешний идентификатор. Максимальная длина — 255 символов ||" }, "externalDateCreate": { "type": "string", "description": "| Дата создания внешнего документа в формате ISO 8601 ||" } }, "required": [ "fields", "company", "members", "responsible", "companyProviderUid", "files", "regionDocumentType", "externalSettings", "uuid", "crmId", "employeeCode", "employeeId", "userId", "role", "fileName", "fileType", "fileContent", "externalId", "externalDateCreate" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Параметры отправки документа на подписание (подробное описание) ||" }, "language": { "type": "string", "description": "| Язык названий статусов в ответе. Код языка интерфейса Битрикс24, например `ru` или `en`." }, "company": { "type": "object", "description": "| Компания, от имени которой отправляется документ (подробное описание) ||" }, "members": { "type": "array", "items": {}, "description": "| Список участников подписания. Должен содержать минимум одного участника с ролью `signer` и одного с ролью `assignee` (подробное описание) ||" }, "responsible": { "type": "object", "description": "| Ответственный за документ (подробное описание) ||" }, "companyProviderUid": { "type": "string", "description": "| Идентификатор провайдера подписи. Получить список доступных провайдеров подписи можно методом sign.b2e.company.provider.list ||" }, "files": { "type": "array", "items": {}, "description": "| Файл подписываемого документа (подробное описание) ||" }, "regionDocumentType": { "type": "string", "description": "| Тип документа для региона (подробное описание) ||" }, "externalSettings": { "type": "object", "description": "| Внешние параметры документа (подробное описание) ||" }, "message": { "type": "string", "description": "| Текст сообщения для сотрудника. Сотрудник увидит сообщение в чате вместе с приглашением подписать документ." }, "uuid": { "type": "string", "description": "| UUID компании в HCM Link." }, "crmId": { "type": "integer", "description": "| Идентификатор компании в CRM, подключенный в интеграции как «моя компания» ||" }, "employeeCode": { "type": "string", "description": "| Код сотрудника в HCM Link." }, "employeeId": { "type": "integer", "description": "| Идентификатор сотрудника в HCM Link." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя в Битрикс24 ||" }, "role": { "type": "string", "description": "| Роль участника. Возможные значения:" }, "fileName": { "type": "string", "description": "| Имя файла. Обязательно с расширением `.pdf` ||" }, "fileType": { "type": "string", "description": "| MIME-тип файла. Поддерживается `application/pdf` ||" }, "fileContent": { "type": "string", "description": "| Содержимое файла, закодированное в Base64 ||" }, "externalId": { "type": "string", "description": "| Внешний идентификатор. Максимальная длина — 255 символов ||" }, "externalDateCreate": { "type": "string", "description": "| Дата создания внешнего документа в формате ISO 8601 ||" } }, "required": [ "fields", "company", "members", "responsible", "companyProviderUid", "files", "regionDocumentType", "externalSettings", "uuid", "crmId", "employeeCode", "employeeId", "userId", "role", "fileName", "fileType", "fileContent", "externalId", "externalDateCreate" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.hcmlink.document.get": { "post": { "summary": "Получить подписанный документ HCM Link sign.b2e.hcmlink.document.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.hcmlink.document.get` возвращает данные подписанного документа КЭДО, который связан с HCM Link.", "operationId": "sign_b2e_hcmlink_document_get", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-hcmlink-document-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор участника подписания." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор участника подписания." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.mysafe.tail": { "post": { "summary": "Получить список подписанных документов в сейфе компании sign.b2e.mysafe.tail", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.mysafe.tail` возвращает список подписанных документов в сейфе компании.", "operationId": "sign_b2e_mysafe_tail", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-mysafe-tail.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Аналогичен стандартному параметру start. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Аналогичен стандартному параметру start. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.personal.tail": { "post": { "summary": "Получить список подписанных документов пользователя sign.b2e.personal.tail", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.personal.tail` возвращает список подписанных документов пользователя из раздела КЭДО.", "operationId": "sign_b2e_personal_tail", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-personal-tail.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Аналогичен стандартному параметру start. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Аналогичен стандартному параметру start. Чтобы получить следующую страницу, увеличьте `offset` на значение `limit`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.provider.add": { "post": { "summary": "Добавить провайдера подписи sign.b2e.provider.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.provider.add` подключает к Битрикс24 внешний провайдер подписи.", "operationId": "sign_b2e_provider_add", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-provider-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового провайдера. Описание полей ||" }, "title": { "type": "string", "description": "| Название провайдера ||" }, "description": { "type": "string", "description": "| Краткое описание провайдера ||" }, "iconUri": { "type": "string", "description": "| Адрес иконки провайдера для интерфейса Битрикс24 ||" }, "companyRegUri": { "type": "string", "description": "| Адрес страницы, на которой компания регистрируется у провайдера ||" }, "documentSignUri": { "type": "string", "description": "| Адрес страницы подписания документа у провайдера ||" }, "publicKeyUri": { "type": "string", "description": "| Адрес публичного ключа провайдера. Ключом проверяется подпись документов ||" } }, "required": [ "fields", "title", "description", "iconUri", "documentSignUri", "publicKeyUri" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями нового провайдера. Описание полей ||" }, "title": { "type": "string", "description": "| Название провайдера ||" }, "description": { "type": "string", "description": "| Краткое описание провайдера ||" }, "iconUri": { "type": "string", "description": "| Адрес иконки провайдера для интерфейса Битрикс24 ||" }, "companyRegUri": { "type": "string", "description": "| Адрес страницы, на которой компания регистрируется у провайдера ||" }, "documentSignUri": { "type": "string", "description": "| Адрес страницы подписания документа у провайдера ||" }, "publicKeyUri": { "type": "string", "description": "| Адрес публичного ключа провайдера. Ключом проверяется подпись документов ||" } }, "required": [ "fields", "title", "description", "iconUri", "documentSignUri", "publicKeyUri" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.provider.delete": { "post": { "summary": "Удалить провайдера подписи sign.b2e.provider.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.provider.delete` отключает внешний провайдер подписи от Битрикс24.", "operationId": "sign_b2e_provider_delete", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-provider-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор провайдера." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор провайдера." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.provider.tail": { "post": { "summary": "Получить список провайдеров подписи sign.b2e.provider.tail", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.provider.tail` возвращает список внешних провайдеров подписи, подключенных к Битрикс24.", "operationId": "sign_b2e_provider_tail", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-provider-tail.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Используется для постраничной навигации вместе с `limit`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Количество записей на странице." }, "offset": { "type": "integer", "description": "| Сколько записей пропустить от начала списка. Используется для постраничной навигации вместе с `limit`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.provider.update": { "post": { "summary": "Изменить провайдера подписи sign.b2e.provider.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sign.b2e.provider.update` изменяет данные внешнего провайдера подписи.", "operationId": "sign_b2e_provider_update", "tags": [ "Подпись" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-provider-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор провайдера." }, "fields": { "type": "object", "description": "| Объект с полями провайдера, которые нужно изменить. Передавайте только изменяемые поля: поле, которое не передано или передано со значением `null`, не меняется. Описание полей ||" }, "title": { "type": "string", "description": "| Название провайдера ||" }, "description": { "type": "string", "description": "| Краткое описание провайдера ||" }, "iconUri": { "type": "string", "description": "| Адрес иконки провайдера для интерфейса Битрикс24 ||" }, "companyRegUri": { "type": "string", "description": "| Адрес страницы, на которой компания регистрируется у провайдера ||" }, "documentSignUri": { "type": "string", "description": "| Адрес страницы подписания документа у провайдера ||" }, "publicKeyUri": { "type": "string", "description": "| Адрес публичного ключа провайдера. Ключом проверяется подпись документов ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор провайдера." }, "fields": { "type": "object", "description": "| Объект с полями провайдера, которые нужно изменить. Передавайте только изменяемые поля: поле, которое не передано или передано со значением `null`, не меняется. Описание полей ||" }, "title": { "type": "string", "description": "| Название провайдера ||" }, "description": { "type": "string", "description": "| Краткое описание провайдера ||" }, "iconUri": { "type": "string", "description": "| Адрес иконки провайдера для интерфейса Битрикс24 ||" }, "companyRegUri": { "type": "string", "description": "| Адрес страницы, на которой компания регистрируется у провайдера ||" }, "documentSignUri": { "type": "string", "description": "| Адрес страницы подписания документа у провайдера ||" }, "publicKeyUri": { "type": "string", "description": "| Адрес публичного ключа провайдера. Ключом проверяется подпись документов ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/socialnetwork.api.workgroup.get": { "post": { "summary": "Получить данные о рабочей группе socialnetwork.api.workgroup.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `socialnetwork.api.workgroup.get` возвращает информацию о рабочей группе, проекте, скраме или коллабе по идентификатору.", "operationId": "socialnetwork_api_workgroup_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/socialnetwork-api-workgroup-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Параметры запроса для получения группы. Подробнее ниже ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы. Значение для поля может быть получено методом sonet_group.get ||" }, "select": { "type": "array", "items": {}, "description": "| Список дополнительных полей для извлечения, возвращаемых в `result`. Подробнее ниже ||" }, "mode": { "type": "string", "description": "| Режим запроса. Может принимать только значение `mobile`, которое позволяет получить дополнительные данные в массиве `result[ADDITIONAL_DATA]` ||" }, "ACTIONS": { "type": "string", "description": "| Доступные текущему пользователю операции над группой ||" }, "AVATAR": { "type": "string", "description": "| URL сжатого пользовательского аватара группы ||" }, "AVATAR_DATA": { "type": "string", "description": "| Информация об аватаре группы ||" }, "AVATAR_TYPES": { "type": "string", "description": "| Типы аватаров для групп ||" }, "COUNTERS": { "type": "string", "description": "| Количество непринятых запросов и приглашений на вступление в группу ||" }, "DATE_CREATE": { "type": "string", "description": "| Дата и время создания группы в более читаемом формате ||" }, "DEPARTMENTS": { "type": "string", "description": "| Отделы сотрудников, добавленные в группу ||" }, "EFFICIENCY": { "type": "string", "description": "| Эффективность группы ||" }, "FEATURES": { "type": "string", "description": "| Доступные в группе инструменты, указанные в расширенных настройках группы ||" }, "GROUP_MEMBERS_LIST": { "type": "string", "description": "| Список активных участников группы, приглашенных пользователей и пользователей, ожидающих подтверждения вступления в группу ||" }, "LIST_OF_MEMBERS": { "type": "string", "description": "| Список участников группы с информацией о них ||" }, "LIST_OF_MEMBERS_AWAITING_INVITE": { "type": "string", "description": "| Пользователи, ожидающие подтверждения вступления в группу ||" }, "OWNER_DATA": { "type": "string", "description": "| Данные о владельце группы ||" }, "PIN": { "type": "string", "description": "| Закреплена ли группа у текущего пользователя на странице групп и проектов. Возвращается ключом `result[IS_PIN]` ||" }, "PRIVACY_TYPE": { "type": "string", "description": "| Уровень приватности группы. Возвращается ключом `result[PRIVACY_CODE]` ||" }, "SUBJECT_DATA": { "type": "string", "description": "| Информация о тематике группы, указанной в расширенных настройках группы ||" }, "TAGS": { "type": "string", "description": "| Теги группы, указанные в расширенных настройках группы ||" }, "USER_DATA": { "type": "string", "description": "| Данные о роли текущего пользователя в группе ||" } }, "required": [ "params", "groupId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Параметры запроса для получения группы. Подробнее ниже ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы. Значение для поля может быть получено методом sonet_group.get ||" }, "select": { "type": "array", "items": {}, "description": "| Список дополнительных полей для извлечения, возвращаемых в `result`. Подробнее ниже ||" }, "mode": { "type": "string", "description": "| Режим запроса. Может принимать только значение `mobile`, которое позволяет получить дополнительные данные в массиве `result[ADDITIONAL_DATA]` ||" }, "ACTIONS": { "type": "string", "description": "| Доступные текущему пользователю операции над группой ||" }, "AVATAR": { "type": "string", "description": "| URL сжатого пользовательского аватара группы ||" }, "AVATAR_DATA": { "type": "string", "description": "| Информация об аватаре группы ||" }, "AVATAR_TYPES": { "type": "string", "description": "| Типы аватаров для групп ||" }, "COUNTERS": { "type": "string", "description": "| Количество непринятых запросов и приглашений на вступление в группу ||" }, "DATE_CREATE": { "type": "string", "description": "| Дата и время создания группы в более читаемом формате ||" }, "DEPARTMENTS": { "type": "string", "description": "| Отделы сотрудников, добавленные в группу ||" }, "EFFICIENCY": { "type": "string", "description": "| Эффективность группы ||" }, "FEATURES": { "type": "string", "description": "| Доступные в группе инструменты, указанные в расширенных настройках группы ||" }, "GROUP_MEMBERS_LIST": { "type": "string", "description": "| Список активных участников группы, приглашенных пользователей и пользователей, ожидающих подтверждения вступления в группу ||" }, "LIST_OF_MEMBERS": { "type": "string", "description": "| Список участников группы с информацией о них ||" }, "LIST_OF_MEMBERS_AWAITING_INVITE": { "type": "string", "description": "| Пользователи, ожидающие подтверждения вступления в группу ||" }, "OWNER_DATA": { "type": "string", "description": "| Данные о владельце группы ||" }, "PIN": { "type": "string", "description": "| Закреплена ли группа у текущего пользователя на странице групп и проектов. Возвращается ключом `result[IS_PIN]` ||" }, "PRIVACY_TYPE": { "type": "string", "description": "| Уровень приватности группы. Возвращается ключом `result[PRIVACY_CODE]` ||" }, "SUBJECT_DATA": { "type": "string", "description": "| Информация о тематике группы, указанной в расширенных настройках группы ||" }, "TAGS": { "type": "string", "description": "| Теги группы, указанные в расширенных настройках группы ||" }, "USER_DATA": { "type": "string", "description": "| Данные о роли текущего пользователя в группе ||" } }, "required": [ "params", "groupId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "socialnetwork" ] } ] } }, "/socialnetwork.api.workgroup.list": { "post": { "summary": "Получить список рабочих групп socialnetwork.api.workgroup.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `socialnetwork.api.workgroup.list` возвращает список рабочих групп, проектов, скрамов и коллаб с учетом прав текущего пользователя.", "operationId": "socialnetwork_api_workgroup_list", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/socialnetwork-api-workgroup-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "order": { "type": "object", "description": "| Объект сортировки в формате `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "params": { "type": "object", "description": "| Дополнительные параметры запроса ||" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Идентификатор группы ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор владельца ||" }, "ACTIVE": { "type": "boolean", "description": "| Признак активности группы: `Y` или `N` ||" }, "VISIBLE": { "type": "boolean", "description": "| Видимость группы в общем списке: `Y` или `N` ||" }, "OPENED": { "type": "boolean", "description": "| Открыта ли группа для свободного вступления: `Y` или `N` ||" }, "CLOSED": { "type": "boolean", "description": "| Находится ли группа в архиве: `Y` или `N` ||" }, "PROJECT": { "type": "boolean", "description": "| Тип объекта: `Y` — проект, `N` — группа ||" }, "SUBJECT_ID": { "type": "integer", "description": "| Идентификатор тематики группы ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта группы ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания группы ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Дата изменения группы ||" }, "DATE_ACTIVITY": { "type": "string", "format": "date-time", "description": "| Дата последней активности ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание группы ||" }, "KEYWORDS": { "type": "string", "description": "| Ключевые слова группы ||" }, "LANDING": { "type": "boolean", "description": "| Признак группы для публикации: `Y` или `N` ||" }, "IMAGE_ID": { "type": "integer", "description": "| Идентификатор пользовательского аватара ||" }, "AVATAR_TYPE": { "type": "string", "description": "| Тип системного аватара ||" }, "NUMBER_OF_MEMBERS": { "type": "integer", "description": "| Количество участников ||" }, "NUMBER_OF_MODERATORS": { "type": "integer", "description": "| Количество модераторов ||" }, "INITIATE_PERMS": { "type": "string", "description": "| Кто может приглашать участников:" }, "PROJECT_DATE_START": { "type": "string", "format": "date-time", "description": "| Дата начала проекта ||" }, "PROJECT_DATE_FINISH": { "type": "string", "format": "date-time", "description": "| Дата окончания проекта ||" }, "SCRUM_OWNER_ID": { "type": "integer", "description": "| Идентификатор владельца скрама ||" }, "SCRUM_MASTER_ID": { "type": "integer", "description": "| Идентификатор скрам-мастера ||" }, "SCRUM_SPRINT_DURATION": { "type": "integer", "description": "| Длительность спринта в секундах ||" }, "SCRUM_TASK_RESPONSIBLE": { "type": "string", "description": "| Ответственный по умолчанию в скраме:" }, "TYPE": { "type": "string", "description": "| Тип группы: `group`, `project`, `scrum`, `collab` ||" }, "AVATAR": { "type": "string", "description": "| URL аватара ||" }, "IS_ADMIN": { "type": "string", "description": "| Отключение проверки прав." }, "siteId": { "type": "string", "description": "| Идентификатор сайта, который будет подставлен в автоматический фильтр `SITE_ID` для обычных пользователей." }, "mode": { "type": "string", "description": "| Режим ответа." }, "features": { "type": "string", "description": "| Список кодов инструментов группы, которые нужно учитывать при формировании `additionalData` в режиме `mobile` ||" }, "mandatoryFeatures": { "type": "string", "description": "| Коды инструментов из `features`, которые нужно включить в `additionalData.features` независимо от прав текущего пользователя ||" }, "shouldSelectHasCollabers": { "type": "boolean", "description": "| Добавлять ли в `additionalData` признак наличия внешних участников `hasCollabers`." }, "shouldEnsureHasCollabers": { "type": "boolean", "description": "| Пересчитать ли признак `hasCollabers` перед возвратом ответа." }, "shouldSelectDialogId": { "type": "string", "description": "| Добавлять ли в элемент списка поле с идентификатором чата `dialogId`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "select": { "type": "array", "items": {}, "description": "| Массив, содержащий список полей, которые необходимо выбрать." }, "order": { "type": "object", "description": "| Объект сортировки в формате `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "params": { "type": "object", "description": "| Дополнительные параметры запроса ||" }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Идентификатор группы ||" }, "OWNER_ID": { "type": "integer", "description": "| Идентификатор владельца ||" }, "ACTIVE": { "type": "boolean", "description": "| Признак активности группы: `Y` или `N` ||" }, "VISIBLE": { "type": "boolean", "description": "| Видимость группы в общем списке: `Y` или `N` ||" }, "OPENED": { "type": "boolean", "description": "| Открыта ли группа для свободного вступления: `Y` или `N` ||" }, "CLOSED": { "type": "boolean", "description": "| Находится ли группа в архиве: `Y` или `N` ||" }, "PROJECT": { "type": "boolean", "description": "| Тип объекта: `Y` — проект, `N` — группа ||" }, "SUBJECT_ID": { "type": "integer", "description": "| Идентификатор тематики группы ||" }, "SITE_ID": { "type": "string", "description": "| Идентификатор сайта группы ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Дата создания группы ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Дата изменения группы ||" }, "DATE_ACTIVITY": { "type": "string", "format": "date-time", "description": "| Дата последней активности ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание группы ||" }, "KEYWORDS": { "type": "string", "description": "| Ключевые слова группы ||" }, "LANDING": { "type": "boolean", "description": "| Признак группы для публикации: `Y` или `N` ||" }, "IMAGE_ID": { "type": "integer", "description": "| Идентификатор пользовательского аватара ||" }, "AVATAR_TYPE": { "type": "string", "description": "| Тип системного аватара ||" }, "NUMBER_OF_MEMBERS": { "type": "integer", "description": "| Количество участников ||" }, "NUMBER_OF_MODERATORS": { "type": "integer", "description": "| Количество модераторов ||" }, "INITIATE_PERMS": { "type": "string", "description": "| Кто может приглашать участников:" }, "PROJECT_DATE_START": { "type": "string", "format": "date-time", "description": "| Дата начала проекта ||" }, "PROJECT_DATE_FINISH": { "type": "string", "format": "date-time", "description": "| Дата окончания проекта ||" }, "SCRUM_OWNER_ID": { "type": "integer", "description": "| Идентификатор владельца скрама ||" }, "SCRUM_MASTER_ID": { "type": "integer", "description": "| Идентификатор скрам-мастера ||" }, "SCRUM_SPRINT_DURATION": { "type": "integer", "description": "| Длительность спринта в секундах ||" }, "SCRUM_TASK_RESPONSIBLE": { "type": "string", "description": "| Ответственный по умолчанию в скраме:" }, "TYPE": { "type": "string", "description": "| Тип группы: `group`, `project`, `scrum`, `collab` ||" }, "AVATAR": { "type": "string", "description": "| URL аватара ||" }, "IS_ADMIN": { "type": "string", "description": "| Отключение проверки прав." }, "siteId": { "type": "string", "description": "| Идентификатор сайта, который будет подставлен в автоматический фильтр `SITE_ID` для обычных пользователей." }, "mode": { "type": "string", "description": "| Режим ответа." }, "features": { "type": "string", "description": "| Список кодов инструментов группы, которые нужно учитывать при формировании `additionalData` в режиме `mobile` ||" }, "mandatoryFeatures": { "type": "string", "description": "| Коды инструментов из `features`, которые нужно включить в `additionalData.features` независимо от прав текущего пользователя ||" }, "shouldSelectHasCollabers": { "type": "boolean", "description": "| Добавлять ли в `additionalData` признак наличия внешних участников `hasCollabers`." }, "shouldEnsureHasCollabers": { "type": "boolean", "description": "| Пересчитать ли признак `hasCollabers` перед возвратом ответа." }, "shouldSelectDialogId": { "type": "string", "description": "| Добавлять ли в элемент списка поле с идентификатором чата `dialogId`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "socialnetwork" ] } ] } }, "/task.checklistitem.add": { "post": { "summary": "Добавить пункт чек-листа task.checklistitem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.add` добавляет новый пункт чек-листа в задаче.", "operationId": "task_checklistitem_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "FIELDS": { "type": "object", "description": "| Объект с полями пункта чек-листа ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке ||" }, "IS_COMPLETE": { "type": "string", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "string", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта. Используйте для вложенных чек-листов." } }, "required": [ "TASKID", "FIELDS", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "FIELDS": { "type": "object", "description": "| Объект с полями пункта чек-листа ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке ||" }, "IS_COMPLETE": { "type": "string", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "string", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта. Используйте для вложенных чек-листов." } }, "required": [ "TASKID", "FIELDS", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.complete": { "post": { "summary": "Пометить пункт чек-листа как выполненный task.checklistitem.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.complete` отмечает пункт чек-листа как выполненный.", "operationId": "task_checklistitem_complete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.delete": { "post": { "summary": "Удалить пункт чек-листа task.checklistitem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.delete` удаляет пункт чек-листа вместе со всеми подпунктами.", "operationId": "task_checklistitem_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.deleteall": { "post": { "summary": "Удалить все чек-листы задачи task.checklistitem.deleteall", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.deleteall` удаляет все чек-листы задачи вместе со всеми пунктами, их участниками и файлами.", "operationId": "task_checklistitem_deleteall", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-delete-all.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "TASKID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "TASKID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.get": { "post": { "summary": "Получить пункт чек-листа task.checklistitem.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.get` получает описание пункта чек-листа по идентификатору.", "operationId": "task_checklistitem_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.getlist": { "post": { "summary": "Получить список пунктов чек-листа task.checklistitem.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.getlist` получает список пунктов чек-листов в задаче.", "operationId": "task_checklistitem_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." } }, "required": [ "TASKID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." } }, "required": [ "TASKID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.getmanifest": { "post": { "summary": "Получить список методов и их описание task.checklistitem.getmanifest", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.getmanifest` получает информацию о методах работы с пунктами чек-листа задач `task.checklistitem.*`.", "operationId": "task_checklistitem_getmanifest", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-get-manifest.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.isactionallowed": { "post": { "summary": "Проверить разрешение действия task.checklistitem.isactionallowed", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.isactionallowed` проверяет, разрешено ли действие с пунктом чек-листа в задаче. Права проверяются для пользователя, от имени которого выполнен запрос: владельца вебхука или пользователя, для которого получен токен приложения.", "operationId": "task_checklistitem_isactionallowed", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-is-action-allowed.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "ACTIONID": { "type": "integer", "description": "| Идентификатор проверяемого действия:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "ACTIONID": { "type": "integer", "description": "| Идентификатор проверяемого действия:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.moveafteritem": { "post": { "summary": "Перенести пункт чек-листа task.checklistitem.moveafteritem", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.moveafteritem` перемещает пункт чек-листа `ITEMID` в позицию после пункта `AFTERITEMID`.", "operationId": "task_checklistitem_moveafteritem", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-move-after-item.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор перемещаемого пункта чек-листа." }, "AFTERITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа, после которого нужно расположить перемещаемый пункт." } }, "required": [ "TASKID", "ITEMID", "AFTERITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор перемещаемого пункта чек-листа." }, "AFTERITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа, после которого нужно расположить перемещаемый пункт." } }, "required": [ "TASKID", "ITEMID", "AFTERITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.renew": { "post": { "summary": "Пометить пункт чек-листа как невыполненный task.checklistitem.renew", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.renew` отмечает выполненный пункт чек-листа как невыполненный.", "operationId": "task_checklistitem_renew", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-renew.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.update": { "post": { "summary": "Изменить пункт чек-листа task.checklistitem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.checklistitem.update` изменяет существующий пункт чек-листа.", "operationId": "task_checklistitem_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/checklist-item/task-checklist-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "FIELDS": { "type": "object", "description": "| Объект с полями пункта чек-листа. Передайте только поля, которые нужно изменить ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке ||" }, "IS_COMPLETE": { "type": "string", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "string", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта. Используйте для вложенных чек-листов." } }, "required": [ "TASKID", "ITEMID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "FIELDS": { "type": "object", "description": "| Объект с полями пункта чек-листа. Передайте только поля, которые нужно изменить ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке ||" }, "IS_COMPLETE": { "type": "string", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "string", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта. Используйте для вложенных чек-листов." } }, "required": [ "TASKID", "ITEMID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.comment.add": { "post": { "summary": "Добавить комментарий к задаче task.comment.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [tasks.task.chat.message.send](../tasks-task-chat-message-send.md).", "operationId": "task_comment_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-comment-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "COMMENTTEXT": { "type": "string", "description": "| Комментарий ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "COMMENTTEXT": { "type": "string", "description": "| Комментарий ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.add": { "post": { "summary": "Добавить комментарий task.commentitem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.commentitem.add` добавляет новый комментарий к задаче.", "operationId": "task_commentitem_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/comment-item/task-comment-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "FIELDS": { "type": "object", "description": "| Объект с полями комментария ||" }, "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "AUTHOR_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого нужно создать комментарий." }, "POST_DATE": { "type": "string", "description": "| Дата сообщения ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Массив с идентификаторами файлов с Диска. Перед каждым идентификатором укажите префикс `n`, например `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "FIELDS", "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "FIELDS": { "type": "object", "description": "| Объект с полями комментария ||" }, "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "AUTHOR_ID": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого нужно создать комментарий." }, "POST_DATE": { "type": "string", "description": "| Дата сообщения ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Массив с идентификаторами файлов с Диска. Перед каждым идентификатором укажите префикс `n`, например `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "FIELDS", "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.delete": { "post": { "summary": "Удалить комментарий task.commentitem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.commentitem.delete` удаляет комментарий.", "operationId": "task_commentitem_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/comment-item/task-comment-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.get": { "post": { "summary": "Получить комментарий по идентификатору task.commentitem.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.commentitem.get` получает комментарий по идентификатору.", "operationId": "task_commentitem_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/comment-item/task-comment-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.getlist": { "post": { "summary": "Получить список комментариев task.commentitem.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.commentitem.getlist` получает список комментариев задачи.", "operationId": "task_commentitem_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/comment-item/task-comment-item-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации результата вида `{\"поле\": \"значение фильтра\", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений." } }, "required": [ "TASKID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации результата вида `{\"поле\": \"значение фильтра\", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений." } }, "required": [ "TASKID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.update": { "post": { "summary": "Обновить комментарий task.commentitem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.commentitem.update` обновляет комментарий.", "operationId": "task_commentitem_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/comment-item/task-comment-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." }, "FIELDS": { "type": "object", "description": "| Объект с полями комментария ||" }, "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Массив с идентификаторами файлов с Диска. Перед каждым идентификатором укажите префикс `n`, например `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "ITEMID", "FIELDS", "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор комментария." }, "FIELDS": { "type": "object", "description": "| Объект с полями комментария ||" }, "POST_MESSAGE": { "type": "string", "description": "| Текст сообщения ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Массив с идентификаторами файлов с Диска. Перед каждым идентификатором укажите префикс `n`, например `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "ITEMID", "FIELDS", "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.dependence.add": { "post": { "summary": "Создать связь между задачами task.dependence.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод создает зависимость одной задачи от другой.", "operationId": "task_dependence_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/task-dependence-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| Идентификатор задачи, от которой создается зависимость ||" }, "taskIdTo": { "type": "integer", "description": "| Идентификатор задачи, для которой создается зависимость ||" }, "linkType": { "type": "integer", "description": "| Тип зависимости:" } }, "required": [ "taskIdFrom", "taskIdTo", "linkType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| Идентификатор задачи, от которой создается зависимость ||" }, "taskIdTo": { "type": "integer", "description": "| Идентификатор задачи, для которой создается зависимость ||" }, "linkType": { "type": "integer", "description": "| Тип зависимости:" } }, "required": [ "taskIdFrom", "taskIdTo", "linkType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.dependence.delete": { "post": { "summary": "Удалить связь между задачами task.dependence.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.dependence.delete` удаляет связь между двумя задачами в диаграмме Ганта. Сами задачи не меняются.", "operationId": "task_dependence_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/task-dependence-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| Идентификатор задачи, от которой зависит вторая задача. То же значение, что передавали в `taskIdFrom` при создании связи методом task.dependence.add ||" }, "taskIdTo": { "type": "integer", "description": "| Идентификатор зависимой задачи. То же значение, что передавали в `taskIdTo` при создании связи." } }, "required": [ "taskIdFrom", "taskIdTo" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| Идентификатор задачи, от которой зависит вторая задача. То же значение, что передавали в `taskIdFrom` при создании связи методом task.dependence.add ||" }, "taskIdTo": { "type": "integer", "description": "| Идентификатор зависимой задачи. То же значение, что передавали в `taskIdTo` при создании связи." } }, "required": [ "taskIdFrom", "taskIdTo" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.add": { "post": { "summary": "Добавить запись о затраченном времени task.elapseditem.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.add` добавляет затраченное время к задаче. Возвращает идентификатор добавленной записи.", "operationId": "task_elapseditem_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ARFIELDS": { "type": "object", "description": "| Поля записи о затраченном времени (подробное описание) ||" }, "SECONDS": { "type": "integer", "description": "| Количество затраченного времени в секундах ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Текст комментария ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор автора записи. По умолчанию — идентификатор текущего пользователя. Передать идентификатор другого пользователя нельзя ||" }, "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания записи. По умолчанию — текущие дата и время ||" }, "DATE_START": { "type": "string", "format": "date-time", "description": "| Дата и время начала учета ||" }, "DATE_STOP": { "type": "string", "format": "date-time", "description": "| Дата и время завершения учета ||" }, "SOURCE": { "type": "integer", "description": "| Источник записи. Метод всегда сохраняет значение `2` — запись добавлена вручную. Переданное значение заменяется на `2` ||" } }, "required": [ "TASKID", "ARFIELDS", "SECONDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ARFIELDS": { "type": "object", "description": "| Поля записи о затраченном времени (подробное описание) ||" }, "SECONDS": { "type": "integer", "description": "| Количество затраченного времени в секундах ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Текст комментария ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор автора записи. По умолчанию — идентификатор текущего пользователя. Передать идентификатор другого пользователя нельзя ||" }, "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания записи. По умолчанию — текущие дата и время ||" }, "DATE_START": { "type": "string", "format": "date-time", "description": "| Дата и время начала учета ||" }, "DATE_STOP": { "type": "string", "format": "date-time", "description": "| Дата и время завершения учета ||" }, "SOURCE": { "type": "integer", "description": "| Источник записи. Метод всегда сохраняет значение `2` — запись добавлена вручную. Переданное значение заменяется на `2` ||" } }, "required": [ "TASKID", "ARFIELDS", "SECONDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.delete": { "post": { "summary": "Удалить запись о затраченном времени task.elapseditem.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.delete` удаляет запись о затраченном времени.", "operationId": "task_elapseditem_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.get": { "post": { "summary": "Получить запись о затраченном времени по идентификатору task.elapseditem.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.get` возвращает запись о затраченном времени по ее идентификатору.", "operationId": "task_elapseditem_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.getlist": { "post": { "summary": "Получить список записей о затраченном времени task.elapseditem.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.getlist` возвращает список записей о затраченном времени по задаче.", "operationId": "task_elapseditem_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "order": { "type": "object", "description": "| Объект для сортировки результата (подробное описание) ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации результата (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив полей записей, которые будут возвращены методом (подробное описание)" }, "params": { "type": "object", "description": "| Объект для опций вызова (подробное описание) ||" }, "ID": { "type": "string", "description": "| Идентификатор записи о затраченном времени. Может принимать значения:" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи. Может принимать значения:" }, "USER_ID": { "type": "string", "description": "| Идентификатор пользователя, от имени которого была сделана запись о затраченном времени. Может принимать значения:" }, "MINUTES": { "type": "string", "description": "| Затраченное время, минуты. Может принимать значения:" }, "SECONDS": { "type": "string", "description": "| Затраченное время, секунды. Может принимать значения:" }, "CREATED_DATE": { "type": "string", "description": "| Дата создания записи. Может принимать значения:" }, "DATE_START": { "type": "string", "description": "| Дата начала. Может принимать значения:" }, "DATE_STOP": { "type": "string", "description": "| Дата конца. Может принимать значения:" }, "COMMENT_TEXT": { "type": "string", "description": "| Комментарий ||" }, "SOURCE": { "type": "string", "description": "| Источник записи ||" }, "NAV_PARAMS": { "type": "object", "description": "| Настройки постраничной навигации (подробное описание) ||" }, "nPageSize": { "type": "integer", "description": "| Количество элементов на странице. В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 записей ||" }, "iNumPage": { "type": "integer", "description": "| Номер страницы при постраничной навигации ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "order": { "type": "object", "description": "| Объект для сортировки результата (подробное описание) ||" }, "filter": { "type": "object", "description": "| Объект для фильтрации результата (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив полей записей, которые будут возвращены методом (подробное описание)" }, "params": { "type": "object", "description": "| Объект для опций вызова (подробное описание) ||" }, "ID": { "type": "string", "description": "| Идентификатор записи о затраченном времени. Может принимать значения:" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи. Может принимать значения:" }, "USER_ID": { "type": "string", "description": "| Идентификатор пользователя, от имени которого была сделана запись о затраченном времени. Может принимать значения:" }, "MINUTES": { "type": "string", "description": "| Затраченное время, минуты. Может принимать значения:" }, "SECONDS": { "type": "string", "description": "| Затраченное время, секунды. Может принимать значения:" }, "CREATED_DATE": { "type": "string", "description": "| Дата создания записи. Может принимать значения:" }, "DATE_START": { "type": "string", "description": "| Дата начала. Может принимать значения:" }, "DATE_STOP": { "type": "string", "description": "| Дата конца. Может принимать значения:" }, "COMMENT_TEXT": { "type": "string", "description": "| Комментарий ||" }, "SOURCE": { "type": "string", "description": "| Источник записи ||" }, "NAV_PARAMS": { "type": "object", "description": "| Настройки постраничной навигации (подробное описание) ||" }, "nPageSize": { "type": "integer", "description": "| Количество элементов на странице. В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 записей ||" }, "iNumPage": { "type": "integer", "description": "| Номер страницы при постраничной навигации ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.getmanifest": { "post": { "summary": "Получить перечень методов и их описаний task.elapseditem.getmanifest", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.getmanifest` возвращает список методов вида `task.elapseditem.*` и их описание.", "operationId": "task_elapseditem_getmanifest", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-get-manifest.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.isactionallowed": { "post": { "summary": "Проверить разрешение действия task.elapseditem.isactionallowed", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.isactionallowed` проверяет, разрешено ли действие над записью: создание, изменение и удаление.", "operationId": "task_elapseditem_isactionallowed", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-is-action-allowed.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." }, "ACTIONID": { "type": "integer", "description": "| Идентификатор действия:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." }, "ACTIONID": { "type": "integer", "description": "| Идентификатор действия:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.update": { "post": { "summary": "Изменить запись о затраченном времени task.elapseditem.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.elapseditem.update` изменяет параметры указанной записи о затраченном времени.", "operationId": "task_elapseditem_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/elapsed-item/task-elapsed-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." }, "ARFIELDS": { "type": "object", "description": "| Изменяемые поля записи (подробное описание) ||" }, "SECONDS": { "type": "integer", "description": "| Количество затраченного времени в секундах ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Текст комментария ||" }, "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания записи ||" } }, "required": [ "TASKID", "ITEMID", "ARFIELDS", "SECONDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Идентификатор задачи." }, "ITEMID": { "type": "integer", "description": "| Идентификатор записи о затраченном времени." }, "ARFIELDS": { "type": "object", "description": "| Изменяемые поля записи (подробное описание) ||" }, "SECONDS": { "type": "integer", "description": "| Количество затраченного времени в секундах ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Текст комментария ||" }, "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Дата создания записи ||" } }, "required": [ "TASKID", "ITEMID", "ARFIELDS", "SECONDS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.add": { "post": { "summary": "Добавить задачу task.item.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.add` создает новую задачу. Возвращает идентификатор добавленной задачи. Доступны следующие [поля](./index.md).", "operationId": "task_item_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKDATA": { "type": "array", "items": {}, "description": "| Массив полей данных по задаче (`TITLE`, `DESCRIPTION` и так далее) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKDATA": { "type": "array", "items": {}, "description": "| Массив полей данных по задаче (`TITLE`, `DESCRIPTION` и так далее) ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.addfile": { "post": { "summary": "Загрузить файл к задаче task.item.addfile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [tasks.task.files.attach](../../tasks-task-files-attach.md).", "operationId": "task_item_addfile", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-add-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "CONTENT": { "type": "string", "description": "| Содержимое файла в формате `base64` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "CONTENT": { "type": "string", "description": "| Содержимое файла в формате `base64` ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.addtofavorite": { "post": { "summary": "Добавить задачу в Избранное task.item.addtofavorite", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации - не указаны типы параметров", "operationId": "task_item_addtofavorite", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-add-to-favourite.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "PARAMS": { "type": "string", "description": "| Параметр содержит ключ `AFFECT_CHILDREN`. Он указывает, добавлять ли в Избранное подзадачи данной задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "PARAMS": { "type": "string", "description": "| Параметр содержит ключ `AFFECT_CHILDREN`. Он указывает, добавлять ли в Избранное подзадачи данной задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.approve": { "post": { "summary": "Перевести ожидающую контроля задачу в статус «завершена» task.item.approve", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.approve` переводит задачу, ожидающую контроля, в статус «завершена».", "operationId": "task_item_approve", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-approve.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.complete": { "post": { "summary": "Перевести задачу в статус «завершена» task.item.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.complete` переводит задачу в статус «завершена» или «условно завершена (ждет контроля исполнителя)».", "operationId": "task_item_complete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.defer": { "post": { "summary": "Перевести задачу в статус «отложена» task.item.defer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.defer` переводит задачу в статус «отложена». Для выполнения данной операции задача должна быть в статусе [Выполняется](./task-item-start-execution.md).", "operationId": "task_item_defer", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-defer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.delegate": { "post": { "summary": "Делегировать задачу task.item.delegate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.delegate` делегирует задачу новому пользователю.", "operationId": "task_item_delegate", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-delegate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "USERID": { "type": "string", "description": "| Идентификатор нового исполнителя (ответственного) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "USERID": { "type": "string", "description": "| Идентификатор нового исполнителя (ответственного) ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.delete": { "post": { "summary": "Удалить задачу task.item.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.delete` удаляет задачу.", "operationId": "task_item_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.deletefile": { "post": { "summary": "Удалить привязку файла к задаче task.item.deletefile", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [tasks.task.update](../../tasks-task-update.md).", "operationId": "task_item_deletefile", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-delete-file.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "ATTACHMENT_ID": { "type": "string", "description": "| Идентификатор прикрепленного файла ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "ATTACHMENT_ID": { "type": "string", "description": "| Идентификатор прикрепленного файла ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.deletefromfavorite": { "post": { "summary": "Удалить задачу из Избранного task.item.deletefromfavorite", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.deletefromfavorite` удаляет задачу из Избранного.", "operationId": "task_item_deletefromfavorite", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-delete-from-favorite.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "PARAMS": { "type": "string", "description": "| Параметр содержит ключ `AFFECT_CHILDREN`. Он указывает, добавлять ли в Избранное подзадачи данной задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "auth": { "type": "string", "description": "| Токен авторизации ||" }, "TASK_ID": { "type": "string", "description": "| Идентификатор задачи ||" }, "PARAMS": { "type": "string", "description": "| Параметр содержит ключ `AFFECT_CHILDREN`. Он указывает, добавлять ли в Избранное подзадачи данной задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.disapprove": { "post": { "summary": "Перевести ожидающую контроля задачу в статус «не выполняется» task.item.disapprove", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.disapprove` переводит задачу, ожидающую контроля, в статус «не выполняется».", "operationId": "task_item_disapprove", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-disapprove.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getallowedactions": { "post": { "summary": "Получить список действий над задачей task.item.getallowedactions", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getallowedactions` возвращает массив идентификаторов допустимых действий над задачей.", "operationId": "task_item_getallowedactions", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-allowed-actions.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getallowedtaskactionsasstrings": { "post": { "summary": "Получить список названий действий и их допустимость task.item.getallowedtaskactionsasstrings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getallowedtaskactionsasstrings` возвращает массив, ключи которого являются названиями действий (названия соответствуют константам PHP-класса `CTaskItem`), а значения показывают, допустимо действие (`true`) или нет (`false`).", "operationId": "task_item_getallowedtaskactionsasstrings", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-allowed-task-actions-as-strings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdata": { "post": { "summary": "Получить данные о задаче task.item.getdata", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getdata` возвращает массив данных о задаче (`TITLE`, `DESCRIPTION` и так далее). Доступны следующие [поля](./index.md).", "operationId": "task_item_getdata", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-data.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdependson": { "post": { "summary": "Получить список предыдущих задач task.item.getdependson", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getdependson` возвращает массив, содержащий идентификаторы задач, от которых зависит задача (опция `Предыдущие задачи` в форме создания задачи).", "operationId": "task_item_getdependson", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-dependson.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdescription": { "post": { "summary": "Получить описание задачи task.item.getdescription", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getdescription` возвращает описание задачи.", "operationId": "task_item_getdescription", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-description.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "FORMAT": { "type": "string", "description": "| Допустимые значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "FORMAT": { "type": "string", "description": "| Допустимые значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getfiles": { "post": { "summary": "Получить ссылки на прикрепленные к задаче файлы task.item.getfiles", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getfiles` возвращает массив, содержащий ссылки на файлы, прикрепленные к задаче.", "operationId": "task_item_getfiles", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-files.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getmanifest": { "post": { "summary": "Получить перечень методов task.item.* с их описанием task.item.getmanifest", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.getmanifest` возвращает список методов вида `task.item.*` и их описание.", "operationId": "task_item_getmanifest", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-get-manifest.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.isactionallowed": { "post": { "summary": "Проверить, разрешено ли действие task.item.isactionallowed", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.isactionallowed` возвращает `true` в случае, если действие разрешено. В противном случае вернется `false`.", "operationId": "task_item_isactionallowed", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-is-action-allowed.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "ACTIONID": { "type": "string", "description": "| Идентификатор проверяемого действия (смотрите константы метода task.item.getallowedactions) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" }, "ACTIONID": { "type": "string", "description": "| Идентификатор проверяемого действия (смотрите константы метода task.item.getallowedactions) ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.list": { "post": { "summary": "Получить список задач task.item.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.list` возвращает массив задач, каждая из которых содержит массив полей (аналогичен массиву, возвращаемому [task.item.getdata](task-item-get-data.md)).", "operationId": "task_item_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Массив вида `{'поле_сортировки': 'направление сортировки' [, ...]}` для сортировки результата. Поле для сортировки может принимать значения:" }, "FILTER": { "type": "object", "description": "| Массив вида `{'фильтруемое_поле': 'значение фильтра' [, ...]}`. Фильтруемое поле может принимать значения:" }, "PARAMS": { "type": "array", "items": {}, "description": "| Массив для опций вызова. Элементом является массив `NAV_PARAMS` вида `{'опция вызова': 'значение' [, ...]}`, хранящий следующие опции:" }, "SELECT": { "type": "array", "items": {}, "description": "| Массив полей записей, которые будут возвращены методом. Если в массиве присутствует значение `\"*\"`, то будут возвращены все доступные поля." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Массив вида `{'поле_сортировки': 'направление сортировки' [, ...]}` для сортировки результата. Поле для сортировки может принимать значения:" }, "FILTER": { "type": "object", "description": "| Массив вида `{'фильтруемое_поле': 'значение фильтра' [, ...]}`. Фильтруемое поле может принимать значения:" }, "PARAMS": { "type": "array", "items": {}, "description": "| Массив для опций вызова. Элементом является массив `NAV_PARAMS` вида `{'опция вызова': 'значение' [, ...]}`, хранящий следующие опции:" }, "SELECT": { "type": "array", "items": {}, "description": "| Массив полей записей, которые будут возвращены методом. Если в массиве присутствует значение `\"*\"`, то будут возвращены все доступные поля." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.renew": { "post": { "summary": "Перевести задачу в статус «не выполняется» task.item.renew", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.renew` переводит задачу в статус «не выполняется». Применяется для задач в статусе [Завершена](./task-item-complete.md).", "operationId": "task_item_renew", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-renew.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.startexecution": { "post": { "summary": "Перевести задачу в статус «выполняется» task.item.startexecution", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.startexecution` переводит задачу в статус «выполняется».", "operationId": "task_item_startexecution", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-start-execution.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.update": { "post": { "summary": "Изменить задачу task.item.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.update` обновляет данные по задаче. Доступны для обновления следующие [поля](./index.md). При обновлении данных по задаче учитывается бизнес-логика и права. Например, исполнитель не может переименовать задачу — в таком случае будет сгенерирована ошибка.", "operationId": "task_item_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-item-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи. ||" }, "TASKDATA": { "type": "string", "description": "| Список полей с новыми значениями. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "string", "description": "| Идентификатор задачи. ||" }, "TASKDATA": { "type": "string", "description": "| Список полей с новыми значениями. ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.add": { "post": { "summary": "Добавить пользовательское поле task.item.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.add` создает пользовательское поле задачи.", "operationId": "task_item_userfield_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Набор параметров создаваемого поля (подробное описание) ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля." }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Подпись в форме редактирования (подробное описание) ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля ||" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "MULTIPLE": { "type": "string", "description": "| Множественное значение. Возможные значения:" }, "MANDATORY": { "type": "string", "description": "| Обязательное значение. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки типа поля (подробное описание) ||" }, "ru": { "type": "string", "description": "| Подпись на русском языке ||" }, "en": { "type": "string", "description": "| Подпись на английском языке ||" } }, "required": [ "PARAMS", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Набор параметров создаваемого поля (подробное описание) ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип данных пользовательского поля." }, "FIELD_NAME": { "type": "string", "description": "| Код пользовательского поля ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Подпись в форме редактирования (подробное описание) ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля ||" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "MULTIPLE": { "type": "string", "description": "| Множественное значение. Возможные значения:" }, "MANDATORY": { "type": "string", "description": "| Обязательное значение. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки типа поля (подробное описание) ||" }, "ru": { "type": "string", "description": "| Подпись на русском языке ||" }, "en": { "type": "string", "description": "| Подпись на английском языке ||" } }, "required": [ "PARAMS", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.delete": { "post": { "summary": "Удалить пользовательское поле task.item.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.delete` удаляет пользовательское поле задачи.", "operationId": "task_item_userfield_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.get": { "post": { "summary": "Получить пользовательское поле задачи по идентификатору task.item.userfield.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.get` получает описание пользовательского поля задачи по идентификатору.", "operationId": "task_item_userfield_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.getfields": { "post": { "summary": "Получить поля пользовательского поля task.item.userfield.getfields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.getfields` получает список полей для пользовательских полей задач.", "operationId": "task_item_userfield_getfields", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.getlist": { "post": { "summary": "Получить список пользовательских полей task.item.userfield.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.getlist` получает список пользовательских полей задач.", "operationId": "task_item_userfield_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации результата вида `{\"поле\": \"значение фильтра\", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." }, "FILTER": { "type": "object", "description": "| Объект для фильтрации результата вида `{\"поле\": \"значение фильтра\", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.gettypes": { "post": { "summary": "Получить список доступных типов данных task.item.userfield.gettypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.gettypes` получает доступные типы пользовательских полей.", "operationId": "task_item_userfield_gettypes", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-get-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.update": { "post": { "summary": "Обновить пользовательское поле task.item.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.item.userfield.update` обновляет параметры пользовательского поля задачи.", "operationId": "task_item_userfield_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "DATA": { "type": "object", "description": "| Набор обновляемых параметров поля (подробное описание) ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Подпись в форме редактирования (подробное описание) ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля ||" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "MULTIPLE": { "type": "string", "description": "| Множественное значение. Возможные значения:" }, "MANDATORY": { "type": "string", "description": "| Обязательное значение. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки типа поля (подробное описание) ||" }, "ru": { "type": "string", "description": "| Подпись на русском языке ||" }, "en": { "type": "string", "description": "| Подпись на английском языке ||" } }, "required": [ "ID", "DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "DATA": { "type": "object", "description": "| Набор обновляемых параметров поля (подробное описание) ||" }, "XML_ID": { "type": "string", "description": "| Внешний идентификатор ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Подпись в форме редактирования (подробное описание) ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля ||" }, "SORT": { "type": "integer", "description": "| Сортировка" }, "MULTIPLE": { "type": "string", "description": "| Множественное значение. Возможные значения:" }, "MANDATORY": { "type": "string", "description": "| Обязательное значение. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки типа поля (подробное описание) ||" }, "ru": { "type": "string", "description": "| Подпись на русском языке ||" }, "en": { "type": "string", "description": "| Подпись на английском языке ||" } }, "required": [ "ID", "DATA" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.items.getlist": { "post": { "summary": "Получить список задач task.items.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [tasks.task.list](../tasks-task-list.md).", "operationId": "task_items_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-items-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Массив вида `{'поле_сортировки': 'направление сортировки' [, ...]}` для сортировки результата. Поле для сортировки может принимать значения:" }, "FILTER": { "type": "object", "description": "| Массив вида `{'фильтруемое_поле': \"значение фильтра\" [, ...]}`. Фильтруемое поле может принимать значения:" }, "TASKDATA": { "type": "array", "items": {}, "description": "| Массив возвращаемых полей задачи ||" }, "NAV_PARAMS": { "type": "array", "items": {}, "description": "| Постраничная навигация. Доступна опция `iNumPage` — номер страницы ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Массив вида `{'поле_сортировки': 'направление сортировки' [, ...]}` для сортировки результата. Поле для сортировки может принимать значения:" }, "FILTER": { "type": "object", "description": "| Массив вида `{'фильтруемое_поле': \"значение фильтра\" [, ...]}`. Фильтруемое поле может принимать значения:" }, "TASKDATA": { "type": "array", "items": {}, "description": "| Массив возвращаемых полей задачи ||" }, "NAV_PARAMS": { "type": "array", "items": {}, "description": "| Постраничная навигация. Доступна опция `iNumPage` — номер страницы ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.logitem.list": { "post": { "summary": "Просмотреть историю изменения задачи task.logitem.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Развитие метода остановлено. Используйте [tasks.task.history.list](../../tasks-task-history-list.md).", "operationId": "task_logitem_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/deprecated/task-item/task-log-item-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор задачи ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Идентификатор задачи ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.planner.getlist": { "post": { "summary": "Получить список задач из плана на день task.planner.getlist", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.planner.getList` возвращает идентификаторы задач из «Плана на день» пользователя, от имени которого выполняется запрос. Чтобы получить данные задачи, используйте метод [tasks.task.get](../tasks-task-get.md).", "operationId": "task_planner_getlist", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/planner/task-planner-get-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.add": { "post": { "summary": "Добавить стадию канбана или «Моего плана» task.stages.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.add` добавляет стадию канбана или «Моего плана».", "operationId": "task_stages_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для добавления новой стадии (подробное описание) ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" }, "TITLE": { "type": "string", "description": "| Название стадии ||" }, "COLOR": { "type": "string", "description": "| Цвет стадии — шестнадцатеричный код RGB из 6 символов без `#`, например `FFAAEE`." }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор стадии, после которой надо добавить новую стадию." }, "ENTITY_ID": { "type": "integer", "description": "| Где создать стадию:" } }, "required": [ "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для добавления новой стадии (подробное описание) ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" }, "TITLE": { "type": "string", "description": "| Название стадии ||" }, "COLOR": { "type": "string", "description": "| Цвет стадии — шестнадцатеричный код RGB из 6 символов без `#`, например `FFAAEE`." }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор стадии, после которой надо добавить новую стадию." }, "ENTITY_ID": { "type": "integer", "description": "| Где создать стадию:" } }, "required": [ "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.canmovetask": { "post": { "summary": "Проверить возможность перемещения задачи task.stages.canmovetask", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.canmovetask` проверяет, может ли текущий пользователь перемещать задачи в указанном объекте.", "operationId": "task_stages_canmovetask", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-can-move-task.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор объекта: пользователя для `entityType = U` или группы для `entityType = G`." }, "entityType": { "type": "string", "description": "| Тип объекта:" } }, "required": [ "entityId", "entityType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Идентификатор объекта: пользователя для `entityType = U` или группы для `entityType = G`." }, "entityType": { "type": "string", "description": "| Тип объекта:" } }, "required": [ "entityId", "entityType" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.delete": { "post": { "summary": "Удалить стадию канбана или «Моего плана» task.stages.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.delete` удаляет стадию канбана или «Моего плана».", "operationId": "task_stages_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии, которую необходимо удалить ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии, которую необходимо удалить ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.get": { "post": { "summary": "Получить список стадий канбана или «Моего плана» task.stages.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.get` получает стадии канбана или «Моего плана». Если стадий еще нет, метод сначала создаст стандартные стадии.", "operationId": "task_stages_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Чьи стадии получить:" }, "numeric": { "type": "boolean", "description": "| Если передать `true`, метод вернет стадии массивом, а не объектом с ключами-идентификаторами. По умолчанию — `false` ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" } }, "required": [ "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Чьи стадии получить:" }, "numeric": { "type": "boolean", "description": "| Если передать `true`, метод вернет стадии массивом, а не объектом с ключами-идентификаторами. По умолчанию — `false` ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" } }, "required": [ "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.movetask": { "post": { "summary": "Переместить задачу из одной стадии в другую task.stages.movetask", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.movetask` перемещает задачу в другую стадию и может поставить ее перед другой задачей или после нее.", "operationId": "task_stages_movetask", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-move-task.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" }, "stageId": { "type": "integer", "description": "| `ID` стадии, в которую надо переместить задачу ||" }, "before": { "type": "integer", "description": "| `ID` задачи, перед которой надо поставить задачу в стадии ||" }, "after": { "type": "integer", "description": "| `ID` задачи, после которой надо поставить задачу в стадии ||" } }, "required": [ "id", "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" }, "stageId": { "type": "integer", "description": "| `ID` стадии, в которую надо переместить задачу ||" }, "before": { "type": "integer", "description": "| `ID` задачи, перед которой надо поставить задачу в стадии ||" }, "after": { "type": "integer", "description": "| `ID` задачи, после которой надо поставить задачу в стадии ||" } }, "required": [ "id", "stageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.update": { "post": { "summary": "Обновить стадию канбана или «Моего плана» task.stages.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `task.stages.update` изменяет название, цвет или положение стадии канбана или «Моего плана».", "operationId": "task_stages_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/stages/task-stages-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления стадии канбана или «Моего плана» (подробное описание) ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" }, "TITLE": { "type": "string", "description": "| Название стадии. Если не передать, название останется прежним ||" }, "COLOR": { "type": "string", "description": "| Цвет стадии — шестнадцатеричный код RGB из 6 символов без `#`, например `FF5733` ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор стадии, после которой нужно поставить эту стадию." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор стадии ||" }, "fields": { "type": "object", "description": "| Значения полей для обновления стадии канбана или «Моего плана» (подробное описание) ||" }, "isAdmin": { "type": "boolean", "description": "| Если передать `true`, метод не проверяет права в группе. Параметр действует только для администратора Битрикс24, у других пользователей права проверяются как обычно. По умолчанию — `false` ||" }, "TITLE": { "type": "string", "description": "| Название стадии. Если не передать, название останется прежним ||" }, "COLOR": { "type": "string", "description": "| Цвет стадии — шестнадцатеричный код RGB из 6 символов без `#`, например `FF5733` ||" }, "AFTER_ID": { "type": "integer", "description": "| Идентификатор стадии, после которой нужно поставить эту стадию." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.add": { "post": { "summary": "Добавить бэклог в Скрам tasks.api.scrum.backlog.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.backlog.add` добавляет бэклог в Скрам.", "operationId": "tasks_api_scrum_backlog_add", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект содержащий записи о группе и пользователе (подробное описание приведено ниже) в виде структуры:" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, для которой создается бэклог." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого создается бэклог. Если не передан, создать бэклог не удастся ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил бэклог. Если не передан, в ответе метода будет `0` ||" } }, "required": [ "fields", "groupId", "createdBy" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект содержащий записи о группе и пользователе (подробное описание приведено ниже) в виде структуры:" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, для которой создается бэклог." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, от имени которого создается бэклог. Если не передан, создать бэклог не удастся ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который изменил бэклог. Если не передан, в ответе метода будет `0` ||" } }, "required": [ "fields", "groupId", "createdBy" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.delete": { "post": { "summary": "Удалить бэклог tasks.api.scrum.backlog.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.backlog.delete` удаляет бэклог.", "operationId": "tasks_api_scrum_backlog_delete", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бэклога." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бэклога." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.get": { "post": { "summary": "Получить поля бэклога по идентификатору Скрама tasks.api.scrum.backlog.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.backlog.get` возвращает значения полей бэклога по `id` Скрама.", "operationId": "tasks_api_scrum_backlog_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор группы (Скрама), а не идентификатор бэклога из поля `result.id` ответа." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор группы (Скрама), а не идентификатор бэклога из поля `result.id` ответа." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.getFields": { "post": { "summary": "Получить список доступных полей бэклога tasks.api.scrum.backlog.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.backlog.getFields` возвращает доступные поля бэклога.", "operationId": "tasks_api_scrum_backlog_getFields", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.update": { "post": { "summary": "Обновить бэклог tasks.api.scrum.backlog.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.backlog.update` обновляет бэклог.", "operationId": "tasks_api_scrum_backlog_update", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бэклога." }, "fields": { "type": "object", "description": "| Поля бэклога, которые нужно обновить (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой принадлежит бэклог." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, от кого будет создан бэклог ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, от кого будет модифицирован бэклог ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор бэклога." }, "fields": { "type": "object", "description": "| Поля бэклога, которые нужно обновить (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой принадлежит бэклог." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, от кого будет создан бэклог ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, от кого будет модифицирован бэклог ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.add": { "post": { "summary": "Добавить эпик в Скрам tasks.api.scrum.epic.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет эпик в Скрам.", "operationId": "tasks_api_scrum_epic_add", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей нового эпика (подробное описание) в виде структуры:" }, "description": { "type": "string", "description": "| Описание эпика ||" }, "groupId": { "type": "integer", "description": "| Идентификатор Скрама, в котором создается эпик." }, "color": { "type": "string", "description": "| Цвет эпика, например `#69dafc`, до 18 символов. Формат цвета метод не проверяет и сохраняет строку как есть ||" }, "files": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс `n`, например `[\"n428\", \"n345\"]` ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан создателем эпика. По умолчанию — текущий пользователь ||" } }, "required": [ "fields", "groupId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей нового эпика (подробное описание) в виде структуры:" }, "description": { "type": "string", "description": "| Описание эпика ||" }, "groupId": { "type": "integer", "description": "| Идентификатор Скрама, в котором создается эпик." }, "color": { "type": "string", "description": "| Цвет эпика, например `#69dafc`, до 18 символов. Формат цвета метод не проверяет и сохраняет строку как есть ||" }, "files": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс `n`, например `[\"n428\", \"n345\"]` ||" }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан создателем эпика. По умолчанию — текущий пользователь ||" } }, "required": [ "fields", "groupId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.delete": { "post": { "summary": "Удалить эпик tasks.api.scrum.epic.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет эпик.", "operationId": "tasks_api_scrum_epic_delete", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.get": { "post": { "summary": "Получить поля эпика по его идентификатору tasks.api.scrum.epic.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод получает значения полей эпика по его идентификатору `id`.", "operationId": "tasks_api_scrum_epic_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." }, "withFiles": { "type": "boolean", "description": "| Вернуть ли файлы эпика в поле `files`. По умолчанию `true`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." }, "withFiles": { "type": "boolean", "description": "| Вернуть ли файлы эпика в поле `files`. По умолчанию `true`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.getFields": { "post": { "summary": "Получить список доступных полей эпика tasks.api.scrum.epic.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.epic.getFields` возвращает доступные поля эпика.", "operationId": "tasks_api_scrum_epic_getFields", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.list": { "post": { "summary": "Получить список эпиков tasks.api.scrum.epic.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает список эпиков. В список попадают только эпики тех групп, в которых состоит пользователь.", "operationId": "tasks_api_scrum_epic_list", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле_сортировки\": \"направление сортировки\" [, ...]}`." }, "filter": { "type": "object", "description": "| Объект вида `{\"фильтруемое_поле\": \"значение фильтра\" [, ...]}`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно заполнить в ответе, например `[\"ID\", \"NAME\"]`. Значение `\"*\"` или пустой массив — все поля ||" }, "start": { "type": "integer", "description": "| Смещение выборки, кратное 50, по умолчанию `0`. Размер страницы результатов всегда 50 записей: чтобы получить вторую страницу, передайте `50`, третью — `100`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле_сортировки\": \"направление сортировки\" [, ...]}`." }, "filter": { "type": "object", "description": "| Объект вида `{\"фильтруемое_поле\": \"значение фильтра\" [, ...]}`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно заполнить в ответе, например `[\"ID\", \"NAME\"]`. Значение `\"*\"` или пустой массив — все поля ||" }, "start": { "type": "integer", "description": "| Смещение выборки, кратное 50, по умолчанию `0`. Размер страницы результатов всегда 50 записей: чтобы получить вторую страницу, передайте `50`, третью — `100`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.update": { "post": { "summary": "Обновить эпик в Скраме tasks.api.scrum.epic.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод обновляет эпик в Скраме.", "operationId": "tasks_api_scrum_epic_update", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." }, "fields": { "type": "object", "description": "| Поля эпика, которые нужно изменить (подробное описание), в виде структуры:" }, "description": { "type": "string", "description": "| Описание эпика ||" }, "groupId": { "type": "integer", "description": "| Идентификатор Скрама, в который нужно перенести эпик. Нужен доступ к задачам обеих групп ||" }, "color": { "type": "string", "description": "| Цвет эпика, например `#bbecf1`, до 18 символов ||" }, "files": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска с префиксом `n`, например `[\"n429\"]`." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан создателем эпика ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан последним изменившим эпик. По умолчанию — текущий пользователь ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор эпика." }, "fields": { "type": "object", "description": "| Поля эпика, которые нужно изменить (подробное описание), в виде структуры:" }, "description": { "type": "string", "description": "| Описание эпика ||" }, "groupId": { "type": "integer", "description": "| Идентификатор Скрама, в который нужно перенести эпик. Нужен доступ к задачам обеих групп ||" }, "color": { "type": "string", "description": "| Цвет эпика, например `#bbecf1`, до 18 символов ||" }, "files": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска с префиксом `n`, например `[\"n429\"]`." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан создателем эпика ||" }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который будет указан последним изменившим эпик. По умолчанию — текущий пользователь ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.addStage": { "post": { "summary": "Создать стадию канбана Скрама tasks.api.scrum.kanban.addStage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод создает стадию канбана Скрама.", "operationId": "tasks_api_scrum_kanban_addStage", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-stage.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля, соответствующие доступному списку полей tasks.api.scrum.kanban.getFields (подробное описание приведено ниже) ||" }, "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "type": { "type": "string", "description": "| Тип стадии канбана. Возможные значения: `NEW`, `WORK`, `FINISH`" }, "sort": { "type": "integer", "description": "| Порядок сортировки. Стадии выводятся по возрастанию значения" }, "color": { "type": "string", "description": "| Цвет стадии канбана в виде шестизначного HEX-кода без символа `#`." } }, "required": [ "fields", "sprintId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля, соответствующие доступному списку полей tasks.api.scrum.kanban.getFields (подробное описание приведено ниже) ||" }, "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "type": { "type": "string", "description": "| Тип стадии канбана. Возможные значения: `NEW`, `WORK`, `FINISH`" }, "sort": { "type": "integer", "description": "| Порядок сортировки. Стадии выводятся по возрастанию значения" }, "color": { "type": "string", "description": "| Цвет стадии канбана в виде шестизначного HEX-кода без символа `#`." } }, "required": [ "fields", "sprintId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.addTask": { "post": { "summary": "Добавить задачу в канбан Скрама tasks.api.scrum.kanban.addTask", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод добавляет задачу в канбан Скрама.", "operationId": "tasks_api_scrum_kanban_addTask", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-task.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи. Получить идентификатор можно при помощи метода tasks.task.list ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" } }, "required": [ "sprintId", "taskId", "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи. Получить идентификатор можно при помощи метода tasks.task.list ||" }, "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" } }, "required": [ "sprintId", "taskId", "stageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.deleteStage": { "post": { "summary": "Удалить стадию tasks.api.scrum.kanban.deleteStage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет стадию.", "operationId": "tasks_api_scrum_kanban_deleteStage", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-stage.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" } }, "required": [ "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" } }, "required": [ "stageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.deleteTask": { "post": { "summary": "Удалить задачу из канбана Скрама tasks.api.scrum.kanban.deleteTask", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод удаляет задачу из канбана Скрама. Задача останется в спринте на странице планирования. Метод не перенесет задачу в [бэклог](../backlog/index.md).", "operationId": "tasks_api_scrum_kanban_deleteTask", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-task.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи. Получить идентификатор можно при помощи метода tasks.task.list ||" } }, "required": [ "sprintId", "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи. Получить идентификатор можно при помощи метода tasks.task.list ||" } }, "required": [ "sprintId", "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.getFields": { "post": { "summary": "Получить список доступных полей стадии канбана tasks.api.scrum.kanban.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.kanban.getFields` возвращает доступные поля стадии канбана.", "operationId": "tasks_api_scrum_kanban_getFields", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.getStages": { "post": { "summary": "Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getStages", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод возвращает стадии канбана по идентификатору спринта.", "operationId": "tasks_api_scrum_kanban_getStages", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-stages.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" } }, "required": [ "sprintId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" } }, "required": [ "sprintId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.updateStage": { "post": { "summary": "Обновить стадию канбана Скрама tasks.api.scrum.kanban.updateStage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод изменяет стадию канбана Скрама.", "operationId": "tasks_api_scrum_kanban_updateStage", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-update-stage.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" }, "fields": { "type": "object", "description": "| Поля, соответствующие доступному списку полей tasks.api.scrum.kanban.getFields (подробное описание приведено ниже) ||" }, "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "type": { "type": "string", "description": "| Тип стадии канбана. Возможные значения: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки. Стадии выводятся по возрастанию значения ||" }, "color": { "type": "string", "description": "| Цвет стадии канбана в виде шестизначного HEX-кода без символа `#`, например `00C4FB` ||" } }, "required": [ "stageId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages ||" }, "fields": { "type": "object", "description": "| Поля, соответствующие доступному списку полей tasks.api.scrum.kanban.getFields (подробное описание приведено ниже) ||" }, "sprintId": { "type": "integer", "description": "| Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list ||" }, "type": { "type": "string", "description": "| Тип стадии канбана. Возможные значения: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки. Стадии выводятся по возрастанию значения ||" }, "color": { "type": "string", "description": "| Цвет стадии канбана в виде шестизначного HEX-кода без символа `#`, например `00C4FB` ||" } }, "required": [ "stageId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.add": { "post": { "summary": "Добавить спринт в Скрам tasks.api.scrum.sprint.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.add` добавляет спринт в Скрам.", "operationId": "tasks_api_scrum_sprint_add", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными спринта (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы (Скрама), к которой относится спринт." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создает спринт." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил спринт ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки спринта. По умолчанию `0` ||" }, "dateStart": { "type": "string", "description": "| Дата начала спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Дата окончания спринта. Доступные форматы: `ISO 8601`, `timestamp`." }, "status": { "type": "string", "description": "| Статус спринта. Доступные значения:" } }, "required": [ "fields", "groupId", "createdBy", "dateStart", "dateEnd", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с данными спринта (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы (Скрама), к которой относится спринт." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, который создает спринт." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, который последним изменил спринт ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки спринта. По умолчанию `0` ||" }, "dateStart": { "type": "string", "description": "| Дата начала спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Дата окончания спринта. Доступные форматы: `ISO 8601`, `timestamp`." }, "status": { "type": "string", "description": "| Статус спринта. Доступные значения:" } }, "required": [ "fields", "groupId", "createdBy", "dateStart", "dateEnd", "status" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.complete": { "post": { "summary": "Завершить активный спринт выбранного Скрама tasks.api.scrum.sprint.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.complete` завершает активный спринт выбранного Скрама.", "operationId": "tasks_api_scrum_sprint_complete", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор Скрама — группы с активным спринтом. Это не идентификатор спринта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор Скрама — группы с активным спринтом. Это не идентификатор спринта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.delete": { "post": { "summary": "Удалить спринт tasks.api.scrum.sprint.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.delete` удаляет спринт.", "operationId": "tasks_api_scrum_sprint_delete", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.get": { "post": { "summary": "Получить спринт по идентификатору tasks.api.scrum.sprint.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.get` возвращает данные спринта по его идентификатору.", "operationId": "tasks_api_scrum_sprint_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.getFields": { "post": { "summary": "Получить список доступных полей спринта tasks.api.scrum.sprint.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.getFields` возвращает доступные поля спринта.", "operationId": "tasks_api_scrum_sprint_getFields", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.list": { "post": { "summary": "Получить список спринтов tasks.api.scrum.sprint.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.list` возвращает список спринтов.", "operationId": "tasks_api_scrum_sprint_list", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект вида `{'поле_сортировки': 'направление_сортировки' [, ...]}`, например `{\"ID\": \"desc\"}`." }, "filter": { "type": "object", "description": "| Объект вида `{'фильтруемое_поле': 'значение фильтра' [, ...]}`, например `{\"GROUP_ID\": 1, \"STATUS\": \"active\"}`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно заполнить в ответе, например `[\"ID\", \"NAME\", \"STATUS\"]`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает до 50 спринтов за вызов. Чтобы получить следующую страницу, увеличьте `start` на 50. Ответ не содержит полей `total` и `next`: если пришло меньше 50 спринтов, это последняя страница ||" }, "ID": { "type": "integer", "description": "| Идентификатор спринта ||" }, "GROUP_ID": { "type": "integer", "description": "| Идентификатор Скрама. Получить идентификатор можно методом socialnetwork.api.workgroup.list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип элемента, для спринтов всегда `sprint` ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки спринта ||" }, "CREATED_BY": { "type": "integer", "description": "| Идентификатор пользователя, создавшего спринт ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Идентификатор пользователя, изменившего спринт ||" }, "DATE_START": { "type": "string", "description": "| Дата начала спринта. Поле можно использовать в `order` и `select`. Фильтр по дате не срабатывает: метод возвращает пустой массив при любом формате значения ||" }, "DATE_END": { "type": "string", "description": "| Дата окончания спринта. Поле можно использовать в `order` и `select`. Фильтр по дате не срабатывает, как и для `DATE_START` ||" }, "STATUS": { "type": "string", "description": "| Статус: `planned` — запланирован, `active` — активен, `completed` — завершен ||" }, "INFO": { "type": "object", "description": "| Служебное поле. В ответе метода не возвращается ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект вида `{'поле_сортировки': 'направление_сортировки' [, ...]}`, например `{\"ID\": \"desc\"}`." }, "filter": { "type": "object", "description": "| Объект вида `{'фильтруемое_поле': 'значение фильтра' [, ...]}`, например `{\"GROUP_ID\": 1, \"STATUS\": \"active\"}`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно заполнить в ответе, например `[\"ID\", \"NAME\", \"STATUS\"]`." }, "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает до 50 спринтов за вызов. Чтобы получить следующую страницу, увеличьте `start` на 50. Ответ не содержит полей `total` и `next`: если пришло меньше 50 спринтов, это последняя страница ||" }, "ID": { "type": "integer", "description": "| Идентификатор спринта ||" }, "GROUP_ID": { "type": "integer", "description": "| Идентификатор Скрама. Получить идентификатор можно методом socialnetwork.api.workgroup.list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Тип элемента, для спринтов всегда `sprint` ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки спринта ||" }, "CREATED_BY": { "type": "integer", "description": "| Идентификатор пользователя, создавшего спринт ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Идентификатор пользователя, изменившего спринт ||" }, "DATE_START": { "type": "string", "description": "| Дата начала спринта. Поле можно использовать в `order` и `select`. Фильтр по дате не срабатывает: метод возвращает пустой массив при любом формате значения ||" }, "DATE_END": { "type": "string", "description": "| Дата окончания спринта. Поле можно использовать в `order` и `select`. Фильтр по дате не срабатывает, как и для `DATE_START` ||" }, "STATUS": { "type": "string", "description": "| Статус: `planned` — запланирован, `active` — активен, `completed` — завершен ||" }, "INFO": { "type": "object", "description": "| Служебное поле. В ответе метода не возвращается ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.start": { "post": { "summary": "Запустить спринт tasks.api.scrum.sprint.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.start` запускает спринт.", "operationId": "tasks_api_scrum_sprint_start", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.update": { "post": { "summary": "Изменить спринт tasks.api.scrum.sprint.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.sprint.update` изменяет спринт.", "operationId": "tasks_api_scrum_sprint_update", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." }, "fields": { "type": "object", "description": "| Объект с данными спринта (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы (Скрама), к которой относится спринт." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, создавшего спринт." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, изменившего спринт ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки спринта ||" }, "dateStart": { "type": "string", "description": "| Дата начала спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Дата окончания спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Статус спринта. Доступные значения:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор спринта." }, "fields": { "type": "object", "description": "| Объект с данными спринта (подробное описание) ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы (Скрама), к которой относится спринт." }, "createdBy": { "type": "integer", "description": "| Идентификатор пользователя, создавшего спринт." }, "modifiedBy": { "type": "integer", "description": "| Идентификатор пользователя, изменившего спринт ||" }, "sort": { "type": "integer", "description": "| Порядок сортировки спринта ||" }, "dateStart": { "type": "string", "description": "| Дата начала спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Дата окончания спринта. Доступные форматы: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Статус спринта. Доступные значения:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.get": { "post": { "summary": "Получить поля задачи Скрама по идентификатору tasks.api.scrum.task.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.task.get` получает значения полей задачи Скрама по ее идентификатору `id`.", "operationId": "tasks_api_scrum_task_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.getFields": { "post": { "summary": "Получить поля задачи Скрама tasks.api.scrum.task.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.task.getFields` получает доступные поля задачи Скрама.", "operationId": "tasks_api_scrum_task_getFields", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.update": { "post": { "summary": "Создать или обновить задачу Скрама tasks.api.scrum.task.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.api.scrum.task.update` создает или обновляет задачу Скрама. Вы сможете:", "operationId": "tasks_api_scrum_task_update", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" }, "fields": { "type": "object", "description": "| Объект содержащий записи о задаче скрама (подробное описание приведено ниже) в виде структуры:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи ||" }, "fields": { "type": "object", "description": "| Объект содержащий записи о задаче скрама (подробное описание приведено ниже) в виде структуры:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.activate": { "post": { "summary": "Включить или выключить поток tasks.flow.Flow.activate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.activate` меняет состояние потока на противоположное: включенный выключает, выключенный включает. Задать нужное состояние нельзя.", "operationId": "tasks_flow_Flow_activate", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-activate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, который нужно включить или выключить." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, который нужно включить или выключить." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.create": { "post": { "summary": "Создать поток tasks.flow.Flow.create", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.create` создает поток.", "operationId": "tasks_flow_Flow_create", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-create.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Значения полей для создания потока (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание потока ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой будет привязан поток." }, "ownerId": { "type": "integer", "description": "| Идентификатор администратора потока." }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона, по которому пользователи будут добавлять задачи в поток ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Сколько секунд дается на выполнение задачи, не меньше `3600` — одного часа. От этого времени поток считает крайний срок задачи ||" }, "distributionType": { "type": "string", "description": "| Тип распределения:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Сотрудники или отделы, которые получат задачи. Каждый элемент — пара «тип — идентификатор»." }, "taskCreators": { "type": "array", "items": {}, "description": "| Кто может ставить задачи в поток: пользователи или отделы. Каждый элемент — пара `[\"<тип-объекта>\", \"<идентификатор-объекта>\"]`, например:" }, "matchWorkTime": { "type": "integer", "description": "| Пропускать выходные и праздничные дни для расчета крайнего срока задачи." }, "matchSchedule": { "type": "integer", "description": "| Считать срок выполнения задачи только в рабочие часы по графику работы." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Может ли ответственный менять крайний срок задачи." }, "notifyAtHalfTime": { "type": "integer", "description": "| Уведомлять исполнителя на половине срока задачи." }, "taskControl": { "type": "integer", "description": "| Отправлять выполненную задачу постановщику для проверки." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Количество задач в очереди, при превышении которого администратор потока получит уведомление." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Количество задач в работе, при превышении которого администратор потока получит уведомление." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Эффективность в процентах, при снижении ниже которой администратор потока получит уведомление." } }, "required": [ "flowData", "plannedCompletionTime", "distributionType", "responsibleList" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Значения полей для создания потока (подробное описание) ||" }, "description": { "type": "string", "description": "| Описание потока ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой будет привязан поток." }, "ownerId": { "type": "integer", "description": "| Идентификатор администратора потока." }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона, по которому пользователи будут добавлять задачи в поток ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Сколько секунд дается на выполнение задачи, не меньше `3600` — одного часа. От этого времени поток считает крайний срок задачи ||" }, "distributionType": { "type": "string", "description": "| Тип распределения:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Сотрудники или отделы, которые получат задачи. Каждый элемент — пара «тип — идентификатор»." }, "taskCreators": { "type": "array", "items": {}, "description": "| Кто может ставить задачи в поток: пользователи или отделы. Каждый элемент — пара `[\"<тип-объекта>\", \"<идентификатор-объекта>\"]`, например:" }, "matchWorkTime": { "type": "integer", "description": "| Пропускать выходные и праздничные дни для расчета крайнего срока задачи." }, "matchSchedule": { "type": "integer", "description": "| Считать срок выполнения задачи только в рабочие часы по графику работы." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Может ли ответственный менять крайний срок задачи." }, "notifyAtHalfTime": { "type": "integer", "description": "| Уведомлять исполнителя на половине срока задачи." }, "taskControl": { "type": "integer", "description": "| Отправлять выполненную задачу постановщику для проверки." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Количество задач в очереди, при превышении которого администратор потока получит уведомление." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Количество задач в работе, при превышении которого администратор потока получит уведомление." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Эффективность в процентах, при снижении ниже которой администратор потока получит уведомление." } }, "required": [ "flowData", "plannedCompletionTime", "distributionType", "responsibleList" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.delete": { "post": { "summary": "Удалить поток tasks.flow.Flow.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.delete` удаляет поток по его идентификатору.", "operationId": "tasks_flow_Flow_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Объект с идентификатором потока (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который нужно удалить." } }, "required": [ "flowData", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Объект с идентификатором потока (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который нужно удалить." } }, "required": [ "flowData", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.get": { "post": { "summary": "Получить поток tasks.flow.Flow.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.get` возвращает данные потока по его идентификатору.", "operationId": "tasks_flow_Flow_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, данные которого нужно получить." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, данные которого нужно получить." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.isExists": { "post": { "summary": "Проверить название потока на уникальность tasks.flow.Flow.isExists", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.isExists` проверяет, есть ли в Битрикс24 поток с таким названием. Название потока должно быть уникальным, поэтому проверяйте его перед созданием или переименованием потока.", "operationId": "tasks_flow_Flow_isExists", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-is-exists.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Объект с названием потока для проверки (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который метод пропустит при проверке. Передайте его, если проверяете новое название существующего потока: тогда метод не найдет сам этот поток." } }, "required": [ "flowData" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Объект с названием потока для проверки (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который метод пропустит при проверке. Передайте его, если проверяете новое название существующего потока: тогда метод не найдет сам этот поток." } }, "required": [ "flowData" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.pin": { "post": { "summary": "Закрепить или открепить поток tasks.flow.Flow.pin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.pin` закрепляет поток в списке потоков или открепляет уже закрепленный. Закрепление видит только тот, кто вызвал метод: у других список не изменится.", "operationId": "tasks_flow_Flow_pin", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-pin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, который нужно закрепить или открепить." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| Идентификатор потока, который нужно закрепить или открепить." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.update": { "post": { "summary": "Изменить поток tasks.flow.Flow.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.flow.Flow.update` изменяет поток.", "operationId": "tasks_flow_Flow_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/flow/tasks-flow-flow-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Значения полей для изменения потока (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который нужно изменить." }, "description": { "type": "string", "description": "| Описание потока. Если не передать, описание станет пустым ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой будет привязан поток. Если не передать, группа не изменится ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор администратора потока. Если не передать, администратор не изменится ||" }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона, по которому пользователи будут добавлять задачи в поток ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Сколько секунд дается на выполнение задачи, не меньше `3600` — одного часа. От этого времени поток считает крайний срок задачи. Если не передать, время не изменится ||" }, "distributionType": { "type": "string", "description": "| Тип распределения:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Сотрудники или отделы, которые получат задачи. Каждый элемент — пара «тип — идентификатор»." }, "taskCreators": { "type": "array", "items": {}, "description": "| Кто может ставить задачи в поток: пользователи или отделы. Каждый элемент — пара `[\"<тип-объекта>\", \"<идентификатор-объекта>\"]`, например:" }, "matchWorkTime": { "type": "integer", "description": "| Пропускать выходные и праздничные дни для расчета крайнего срока задачи." }, "matchSchedule": { "type": "integer", "description": "| Считать срок выполнения задачи только в рабочие часы по графику работы." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Может ли ответственный менять крайний срок задачи." }, "notifyAtHalfTime": { "type": "integer", "description": "| Уведомлять исполнителя на половине срока задачи." }, "taskControl": { "type": "integer", "description": "| Отправлять выполненную задачу постановщику для проверки." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Количество задач в очереди, при превышении которого администратор потока получит уведомление." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Количество задач в работе, при превышении которого администратор потока получит уведомление." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Эффективность в процентах, при снижении ниже которой администратор потока получит уведомление." } }, "required": [ "flowData", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Значения полей для изменения потока (подробное описание) ||" }, "id": { "type": "integer", "description": "| Идентификатор потока, который нужно изменить." }, "description": { "type": "string", "description": "| Описание потока. Если не передать, описание станет пустым ||" }, "groupId": { "type": "integer", "description": "| Идентификатор группы, к которой будет привязан поток. Если не передать, группа не изменится ||" }, "ownerId": { "type": "integer", "description": "| Идентификатор администратора потока. Если не передать, администратор не изменится ||" }, "templateId": { "type": "integer", "description": "| Идентификатор шаблона, по которому пользователи будут добавлять задачи в поток ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Сколько секунд дается на выполнение задачи, не меньше `3600` — одного часа. От этого времени поток считает крайний срок задачи. Если не передать, время не изменится ||" }, "distributionType": { "type": "string", "description": "| Тип распределения:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Сотрудники или отделы, которые получат задачи. Каждый элемент — пара «тип — идентификатор»." }, "taskCreators": { "type": "array", "items": {}, "description": "| Кто может ставить задачи в поток: пользователи или отделы. Каждый элемент — пара `[\"<тип-объекта>\", \"<идентификатор-объекта>\"]`, например:" }, "matchWorkTime": { "type": "integer", "description": "| Пропускать выходные и праздничные дни для расчета крайнего срока задачи." }, "matchSchedule": { "type": "integer", "description": "| Считать срок выполнения задачи только в рабочие часы по графику работы." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Может ли ответственный менять крайний срок задачи." }, "notifyAtHalfTime": { "type": "integer", "description": "| Уведомлять исполнителя на половине срока задачи." }, "taskControl": { "type": "integer", "description": "| Отправлять выполненную задачу постановщику для проверки." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Количество задач в очереди, при превышении которого администратор потока получит уведомление." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Количество задач в работе, при превышении которого администратор потока получит уведомление." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Эффективность в процентах, при снижении ниже которой администратор потока получит уведомление." } }, "required": [ "flowData", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.access.get": { "post": { "summary": "Проверить права доступа v 3.0 tasks.task.access.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_access_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-access-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.add": { "post": { "summary": "Добавить задачу v 3.0 tasks.task.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-add-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля задачи. Для создания задачи заполните обязательные поля, без них операция создания не будет выполнена" }, "title": { "type": "string", "description": "| Название задачи ||" }, "creatorId": { "type": "integer", "description": "| Идентификатор постановщика." }, "responsibleId": { "type": "integer", "description": "| Идентификатор исполнителя." } }, "required": [ "fields", "title", "creatorId", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля задачи. Для создания задачи заполните обязательные поля, без них операция создания не будет выполнена" }, "title": { "type": "string", "description": "| Название задачи ||" }, "creatorId": { "type": "integer", "description": "| Идентификатор постановщика." }, "responsibleId": { "type": "integer", "description": "| Идентификатор исполнителя." } }, "required": [ "fields", "title", "creatorId", "responsibleId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.approve": { "post": { "summary": "Принять задачу tasks.task.approve", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.approve` принимает работу исполнителя по задаче при включенном контроле задачи и переводит задачу в статус Завершена.", "operationId": "tasks_task_approve", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-approve.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.chat.message.field.get": { "post": { "summary": "Получить поле сообщения чата задачи tasks.task.chat.message.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_chat_message_field_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-chat-message-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.chat.message.field.list": { "post": { "summary": "Получить список полей сообщения чата задачи tasks.task.chat.message.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_chat_message_field_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-chat-message-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.chat.message.send": { "post": { "summary": "Отправить сообщение в чат задачи tasks.task.chat.message.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_chat_message_send", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-chat-message-send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами сообщения ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи, в чат которой нужно отправить сообщение." }, "text": { "type": "string", "description": "| Текст сообщения ||" } }, "required": [ "fields", "taskId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с параметрами сообщения ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи, в чат которой нужно отправить сообщение." }, "text": { "type": "string", "description": "| Текст сообщения ||" } }, "required": [ "fields", "taskId", "text" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.complete": { "post": { "summary": "Перевести задачу в статус Завершена tasks.task.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.complete` переводит задачу в статус Завершена.", "operationId": "tasks_task_complete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/status/tasks-task-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.counters.get": { "post": { "summary": "Получить счетчики пользователя tasks.task.counters.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.counters.get` получает значения счетчиков задач для указанного пользователя.", "operationId": "tasks_task_counters_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-counters-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого нужно получить счетчики." }, "groupId": { "type": "integer", "description": "| Идентификатор группы, для задач которой нужно получилось счетчики." }, "type": { "type": "string", "description": "| Роль, для которой нужно получить счетчики. Возможные роли:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "integer", "description": "| Идентификатор пользователя, для которого нужно получить счетчики." }, "groupId": { "type": "integer", "description": "| Идентификатор группы, для задач которой нужно получилось счетчики." }, "type": { "type": "string", "description": "| Роль, для которой нужно получить счетчики. Возможные роли:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.defer": { "post": { "summary": "Перевести задачу в статус Отложена tasks.task.defer", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.defer` переводит задачу в статус Отложена.", "operationId": "tasks_task_defer", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/status/tasks-task-defer.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.delegate": { "post": { "summary": "Делегировать задачу tasks.task.delegate", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.delegate` меняет ответственного и делегирует задачу другому пользователю.", "operationId": "tasks_task_delegate", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-delegate.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, которому делегируется задача." } }, "required": [ "taskId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "userId": { "type": "integer", "description": "| Идентификатор пользователя, которому делегируется задача." } }, "required": [ "taskId", "userId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.delete": { "post": { "summary": "Удалить задачу v 3.0 tasks.task.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-delete-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.disapprove": { "post": { "summary": "Отклонить задачу tasks.task.disapprove", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.disapprove` отклоняет задачу и возвращает на доработку исполнителю при включенном контроле задачи.", "operationId": "tasks_task_disapprove", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-disapprove.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.favorite.add": { "post": { "summary": "Добавить задачу в Избранное tasks.task.favorite.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.favorite.add` добавляет задачу в Избранное.", "operationId": "tasks_task_favorite_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-favorite-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.favorite.remove": { "post": { "summary": "Удалить задачу из Избранного tasks.task.favorite.remove", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.favorite.remove` удаляет задачу из Избранного.", "operationId": "tasks_task_favorite_remove", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-favorite-remove.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.field.get": { "post": { "summary": "Получить поле задачи tasks.task.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_field_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.field.list": { "post": { "summary": "Получить список полей задачи v 3.0 tasks.task.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_field_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.file.attach": { "post": { "summary": "Прикрепить файлы к задаче v 3.0 tasks.task.file.attach", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_file_attach", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-file-attach.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, к которой нужно прикрепить файлы." }, "fileIds": { "type": "string", "description": "| Массив идентификаторов файлов Диска." } }, "required": [ "taskId", "fileIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, к которой нужно прикрепить файлы." }, "fileIds": { "type": "string", "description": "| Массив идентификаторов файлов Диска." } }, "required": [ "taskId", "fileIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.files.attach": { "post": { "summary": "Прикрепить файлы к задаче tasks.task.files.attach", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.files.attach` добавляет файл с Диска в задачу. У пользователя должен быть доступ к файлу на чтение или выше.", "operationId": "tasks_task_files_attach", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-files-attach.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, к которой нужно прикрепить файл." }, "fileId": { "type": "integer", "description": "| Идентификатор файла на Диске." } }, "required": [ "taskId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, к которой нужно прикрепить файл." }, "fileId": { "type": "integer", "description": "| Идентификатор файла на Диске." } }, "required": [ "taskId", "fileId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.gantt.link.list": { "post": { "summary": "Получить список связей Ганта задачи tasks.task.gantt.link.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_gantt_link_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-gantt-link-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр для выбора связей Ганта задачи." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." }, "pagination": { "type": "object", "description": "| Объект для управления постраничной навигацией." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Фильтр для выбора связей Ганта задачи." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." }, "pagination": { "type": "object", "description": "| Объект для управления постраничной навигацией." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.get": { "post": { "summary": "Получить задачу по идентификатору v 3.0 tasks.task.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-get-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые вернет метод. Если `select` не задан, приходит базовый набор полей задачи без связанных объектов." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые вернет метод. Если `select` не задан, приходит базовый набор полей задачи без связанных объектов." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.getFields": { "post": { "summary": "Получить список полей tasks.task.getFields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.getFields` возвращает описание стандартных и пользовательских полей задачи. Используйте его, чтобы узнать коды полей для `fields` в [tasks.task.add](./tasks-task-add.md) и [tasks.task.update](./tasks-task-update.md), для `select` и `filter` в [tasks.task.get](./tasks-task-get.md) и [tasks.task.list](./tasks-task-list.md), а также допустимые значения полей-списков.", "operationId": "tasks_task_getFields", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-get-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.getaccess": { "post": { "summary": "Проверить доступ к задаче tasks.task.getaccess", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.getaccess` проверяет доступные действия пользователей над задачей.", "operationId": "tasks_task_getaccess", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-get-access.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "users": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, для которых нужно проверить доступ." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "users": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, для которых нужно проверить доступ." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.history.list": { "post": { "summary": "Получить историю задачи tasks.task.history.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.history.list` получает историю изменений задачи.", "operationId": "tasks_task_history_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-history-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, для которой нужно получить историю." }, "filter": { "type": "object", "description": "| Фильтр по типу события в формате `{FIELD: 'EVENT'}`. Список возможных значений для `FIELD` описан ниже" }, "order": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи, для которой нужно получить историю." }, "filter": { "type": "object", "description": "| Фильтр по типу события в формате `{FIELD: 'EVENT'}`. Список возможных значений для `FIELD` описан ниже" }, "order": { "type": "object", "description": "| Объект для сортировки результата вида `{\"поле\": \"значение сортировки\", ... }`." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.list": { "post": { "summary": "Получить список задач v 3.0 tasks.task.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе. Если `select` не задан, метод возвращает только `id` задачи." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации задач в формате:" }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе. Если `select` не задан, метод возвращает только `id` задачи." }, "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации задач в формате:" }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.mute": { "post": { "summary": "Включить режим «Без звука» tasks.task.mute", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.mute` включает режим «Без звука» для задачи.", "operationId": "tasks_task_mute", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-mute.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.pause": { "post": { "summary": "Перевести задачу в статус Ждет выполнения tasks.task.pause", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.pause` останавливает выполнение задачи и переводит в статус Ждет выполнения.", "operationId": "tasks_task_pause", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/status/tasks-task-pause.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.pin": { "post": { "summary": "Закрепить задачу tasks.task.pin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.pin` закрепляет задачу в списке задач текущего пользователя.", "operationId": "tasks_task_pin", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-pin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.renew": { "post": { "summary": "Возобновить задачу после ее завершения tasks.task.renew", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.renew` возобновляет задачу после ее завершения.", "operationId": "tasks_task_renew", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/status/tasks-task-renew.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.add": { "post": { "summary": "Добавить результат к задаче tasks.task.result.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "tasks_task_result_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "text": { "type": "string", "description": "| Текст результата. Пустую строку метод не примет ||" } }, "required": [ "fields", "taskId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "taskId": { "type": "integer", "description": "| Идентификатор задачи." }, "text": { "type": "string", "description": "| Текст результата. Пустую строку метод не примет ||" } }, "required": [ "fields", "taskId", "text" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.addFromComment": { "post": { "summary": "Добавить комментарий в результат tasks.task.result.addFromComment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.result.addFromComment` закрепляет комментарий как результат выполнения задачи.", "operationId": "tasks_task_result_addFromComment", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-add-from-comment.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| Идентификатор комментария, который нужно закрепить как результат." }, "params": { "type": "object", "description": "| Настройки ответа. Чтобы метод вернул сведения о прикрепленных файлах, передайте `{\"WITH_FILE_INFO\": \"Y\"}`: в ответе придут поле `files` с идентификаторами файлов и поле `fileInfo` с их описанием ||" } }, "required": [ "commentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| Идентификатор комментария, который нужно закрепить как результат." }, "params": { "type": "object", "description": "| Настройки ответа. Чтобы метод вернул сведения о прикрепленных файлах, передайте `{\"WITH_FILE_INFO\": \"Y\"}`: в ответе придут поле `files` с идентификаторами файлов и поле `fileInfo` с их описанием ||" } }, "required": [ "commentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.addfromchatmessage": { "post": { "summary": "Добавить результат из сообщения чата задачи tasks.task.result.addfromchatmessage", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "tasks_task_result_addfromchatmessage", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-addfromchatmessage.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "messageId": { "type": "integer", "description": "| Идентификатор сообщения чата задачи." } }, "required": [ "fields", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "messageId": { "type": "integer", "description": "| Идентификатор сообщения чата задачи." } }, "required": [ "fields", "messageId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.delete": { "post": { "summary": "Удалить результат задачи tasks.task.result.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "tasks_task_result_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор результата. Его возвращают методы tasks.task.result.add, tasks.task.result.addfromchatmessage и tasks.task.result.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор результата. Его возвращают методы tasks.task.result.add, tasks.task.result.addfromchatmessage и tasks.task.result.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.deleteFromComment": { "post": { "summary": "Удалить комментарий из результата tasks.task.result.deleteFromComment", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.result.deleteFromComment` снимает фиксацию комментария как результата задачи. Чтобы удалить сам комментарий, используйте метод [task.commentitem.delete](../comment-item/task-comment-item-delete.md).", "operationId": "tasks_task_result_deleteFromComment", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-delete-from-comment.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| Идентификатор комментария, для которого нужно снять фиксацию результата." } }, "required": [ "commentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| Идентификатор комментария, для которого нужно снять фиксацию результата." } }, "required": [ "commentId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.list": { "post": { "summary": "Получить список результатов задачи v 3.0 tasks.task.result.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "tasks_task_result_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-list-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки списка результатов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Массив условий для фильтрации списка результатов. Обязательно передайте условие по `taskId`, например `[\"taskId\", 51]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно выбрать." }, "pagination": { "type": "object", "description": "| Объект для управления постраничной навигацией." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Объект для сортировки списка результатов в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Массив условий для фильтрации списка результатов. Обязательно передайте условие по `taskId`, например `[\"taskId\", 51]`." }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно выбрать." }, "pagination": { "type": "object", "description": "| Объект для управления постраничной навигацией." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.update": { "post": { "summary": "Обновить результат задачи tasks.task.result.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "tasks_task_result_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/result/tasks-task-result-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор результата. Его возвращают методы tasks.task.result.add, tasks.task.result.addfromchatmessage и tasks.task.result.list ||" }, "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "text": { "type": "string", "description": "| Новый текст результата ||" } }, "required": [ "id", "fields", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор результата. Его возвращают методы tasks.task.result.add, tasks.task.result.addfromchatmessage и tasks.task.result.list ||" }, "fields": { "type": "object", "description": "| Объект с полями результата ||" }, "text": { "type": "string", "description": "| Новый текст результата ||" } }, "required": [ "id", "fields", "text" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.start": { "post": { "summary": "Перевести задачу в статус Выполняется tasks.task.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.start` переводит задачу в статус Выполняется.", "operationId": "tasks_task_start", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/status/tasks-task-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.startwatch": { "post": { "summary": "Включить наблюдение за задачей tasks.task.startwatch", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.startwatch` включает наблюдение за задачей.", "operationId": "tasks_task_startwatch", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-start-watch.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.stopwatch": { "post": { "summary": "Отключить наблюдение за задачей tasks.task.stopwatch", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.stopwatch` отключает наблюдение за задачей.", "operationId": "tasks_task_stopwatch", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-stop-watch.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.unmute": { "post": { "summary": "Отключить режим «Без звука» tasks.task.unmute", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.unmute` выключает режим «Без звука» для задачи.", "operationId": "tasks_task_unmute", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-unmute.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.unpin": { "post": { "summary": "Открепить задачу tasks.task.unpin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.task.unpin` открепляет задачу в списке задач текущего пользователя.", "operationId": "tasks_task_unpin", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/user-actions/tasks-task-unpin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.update": { "post": { "summary": "Изменить задачу v 3.0 tasks.task.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../rest-v3.md).", "operationId": "tasks_task_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/tasks-task-update-rest-v3.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." }, "fields": { "type": "object", "description": "| Значения полей задачи для обновления." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор задачи." }, "fields": { "type": "object", "description": "| Значения полей задачи для обновления." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.template.add": { "post": { "summary": "Добавить шаблон задачи tasks.template.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.add` создает новый шаблон задачи.", "operationId": "tasks_template_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/tasks-template-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового шаблона задачи (подробное описание)." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Поля нового шаблона задачи (подробное описание)." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.add": { "post": { "summary": "Добавить пункт чек-листа в шаблон задачи tasks.template.checklist.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.add` добавляет пункт чек-листа в шаблон задачи.", "operationId": "tasks_template_checklist_add", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "fields": { "type": "object", "description": "| Поля создаваемого пункта чек-листа (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки среди пунктов одного уровня. Чем меньше значение, тем выше пункт." }, "IS_COMPLETE": { "type": "boolean", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" } }, "required": [ "templateId", "fields", "TITLE", "PARENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "fields": { "type": "object", "description": "| Поля создаваемого пункта чек-листа (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа" }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор родительского пункта." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки среди пунктов одного уровня. Чем меньше значение, тем выше пункт." }, "IS_COMPLETE": { "type": "boolean", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" } }, "required": [ "templateId", "fields", "TITLE", "PARENT_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.addAttachmentByContent": { "post": { "summary": "Добавить вложение в пункт чек-листа по содержимому tasks.template.checklist.addAttachmentByContent", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.addAttachmentByContent` добавляет вложение в пункт чек-листа по содержимому файла.", "operationId": "tasks_template_checklist_addAttachmentByContent", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachment-by-content.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "attachmentParameters": { "type": "object", "description": "| Параметры создаваемого вложения (подробное описание) ||" }, "CONTENT": { "type": "string", "description": "| Содержимое файла в формате base64." } }, "required": [ "templateId", "checkListItemId", "attachmentParameters", "CONTENT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "attachmentParameters": { "type": "object", "description": "| Параметры создаваемого вложения (подробное описание) ||" }, "CONTENT": { "type": "string", "description": "| Содержимое файла в формате base64." } }, "required": [ "templateId", "checkListItemId", "attachmentParameters", "CONTENT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.addAttachmentsFromDisk": { "post": { "summary": "Добавить вложения из Диска в пункт чек-листа tasks.template.checklist.addAttachmentsFromDisk", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.addAttachmentsFromDisk` добавляет в пункт чек-листа файлы с Диска.", "operationId": "tasks_template_checklist_addAttachmentsFromDisk", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachments-from-disk.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "filesIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс `n`, например, `[\"n5065\", \"n5067\"]`. Значения без префикса метод пропускает без ошибки и файл не прикрепляет." } }, "required": [ "templateId", "checkListItemId", "filesIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "filesIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс `n`, например, `[\"n5065\", \"n5067\"]`. Значения без префикса метод пропускает без ошибки и файл не прикрепляет." } }, "required": [ "templateId", "checkListItemId", "filesIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.complete": { "post": { "summary": "Завершить пункт чек-листа шаблона задачи tasks.template.checklist.complete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.complete` отмечает пункт чек-листа шаблона как выполненный, вернуть пункт в работу можно методом [tasks.template.checklist.renew](./tasks-template-checklist-renew.md).", "operationId": "tasks_template_checklist_complete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-complete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.delete": { "post": { "summary": "Удалить пункт чек-листа шаблона задачи tasks.template.checklist.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.delete` удаляет пункт чек-листа шаблона задачи.", "operationId": "tasks_template_checklist_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.get": { "post": { "summary": "Получить пункт чек-листа шаблона задачи tasks.template.checklist.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.get` возвращает один пункт чек-листа шаблона задачи.", "operationId": "tasks_template_checklist_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа шаблона." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа шаблона." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.list": { "post": { "summary": "Получить список пунктов чек-листа шаблона задачи tasks.template.checklist.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.list` возвращает список пунктов чек-листа шаблона задачи.", "operationId": "tasks_template_checklist_list", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "filter": { "type": "object", "description": "| Фильтр выборки пунктов чек-листа вида `{ \"поле\": \"значение\", ... }`." }, "select": { "type": "array", "items": {}, "description": "| Список полей для выборки. Если параметр не передан, метод возвращает все поля." }, "order": { "type": "object", "description": "| Объект для сортировки результата вида `{ \"поле\": \"значение сортировки\", ... }`." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "filter": { "type": "object", "description": "| Фильтр выборки пунктов чек-листа вида `{ \"поле\": \"значение\", ... }`." }, "select": { "type": "array", "items": {}, "description": "| Список полей для выборки. Если параметр не передан, метод возвращает все поля." }, "order": { "type": "object", "description": "| Объект для сортировки результата вида `{ \"поле\": \"значение сортировки\", ... }`." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.moveAfter": { "post": { "summary": "Переместить пункт чек-листа после другого tasks.template.checklist.moveAfter", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.moveAfter` перемещает пункт чек-листа после указанного пункта.", "operationId": "tasks_template_checklist_moveAfter", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-move-after.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор перемещаемого пункта." }, "afterItemId": { "type": "integer", "description": "| Идентификатор пункта, после которого нужно разместить перемещаемый пункт. Пункт должен относиться к тому же шаблону `templateId`." } }, "required": [ "templateId", "checkListItemId", "afterItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор перемещаемого пункта." }, "afterItemId": { "type": "integer", "description": "| Идентификатор пункта, после которого нужно разместить перемещаемый пункт. Пункт должен относиться к тому же шаблону `templateId`." } }, "required": [ "templateId", "checkListItemId", "afterItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.moveBefore": { "post": { "summary": "Переместить пункт чек-листа перед другим tasks.template.checklist.moveBefore", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.moveBefore` перемещает пункт чек-листа перед указанным пунктом.", "operationId": "tasks_template_checklist_moveBefore", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-move-before.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор перемещаемого пункта." }, "beforeItemId": { "type": "integer", "description": "| Идентификатор пункта, перед которым нужно разместить перемещаемый пункт. Пункт должен относиться к тому же шаблону `templateId`." } }, "required": [ "templateId", "checkListItemId", "beforeItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор перемещаемого пункта." }, "beforeItemId": { "type": "integer", "description": "| Идентификатор пункта, перед которым нужно разместить перемещаемый пункт. Пункт должен относиться к тому же шаблону `templateId`." } }, "required": [ "templateId", "checkListItemId", "beforeItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.removeAttachments": { "post": { "summary": "Удалить вложения из пункта чек-листа tasks.template.checklist.removeAttachments", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.removeAttachments` удаляет вложения из пункта чек-листа шаблона задачи.", "operationId": "tasks_template_checklist_removeAttachments", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-remove-attachments.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "attachmentsIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов прикреплений для удаления, например `[621, 623]`." } }, "required": [ "templateId", "checkListItemId", "attachmentsIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "attachmentsIds": { "type": "array", "items": {}, "description": "| Массив идентификаторов прикреплений для удаления, например `[621, 623]`." } }, "required": [ "templateId", "checkListItemId", "attachmentsIds" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.renew": { "post": { "summary": "Возобновить пункт чек-листа шаблона задачи tasks.template.checklist.renew", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.renew` снимает отметку выполнения с пункта чек-листа шаблона задачи, отметить пункт выполненным можно методом [tasks.template.checklist.complete](./tasks-template-checklist-complete.md).", "operationId": "tasks_template_checklist_renew", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-renew.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.update": { "post": { "summary": "Обновить пункт чек-листа шаблона задачи tasks.template.checklist.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.checklist.update` обновляет пункт чек-листа шаблона задачи.", "operationId": "tasks_template_checklist_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/checklist/tasks-template-checklist-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "fields": { "type": "object", "description": "| Поля для обновления пункта чек-листа (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа. Пустая строка игнорируется, текст пункта не меняется." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор нового родительского пункта. Получить его можно методом tasks.template.checklist.list." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки среди пунктов одного уровня. Чем меньше значение, тем выше пункт ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" } }, "required": [ "templateId", "checkListItemId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "checkListItemId": { "type": "integer", "description": "| Идентификатор пункта чек-листа." }, "fields": { "type": "object", "description": "| Поля для обновления пункта чек-листа (подробное описание) ||" }, "TITLE": { "type": "string", "description": "| Текст пункта чек-листа. Пустая строка игнорируется, текст пункта не меняется." }, "PARENT_ID": { "type": "integer", "description": "| Идентификатор нового родительского пункта. Получить его можно методом tasks.template.checklist.list." }, "SORT_INDEX": { "type": "integer", "description": "| Индекс сортировки среди пунктов одного уровня. Чем меньше значение, тем выше пункт ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Статус выполнения пункта. Возможные значения:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Отметка, что пункт важный. Возможные значения:" }, "MEMBERS": { "type": "object", "description": "| Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника `TYPE`. Возможные значения типа участника:" } }, "required": [ "templateId", "checkListItemId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.delete": { "post": { "summary": "Удалить шаблон задачи tasks.template.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.delete` удаляет шаблон задачи.", "operationId": "tasks_template_delete", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/tasks-template-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.fields": { "post": { "summary": "Получить список полей шаблона задачи tasks.template.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.fields` возвращает описание полей шаблона задачи.", "operationId": "tasks_template_fields", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/tasks-template-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.get": { "post": { "summary": "Получить шаблон задачи по идентификатору tasks.template.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.get` возвращает данные шаблона задачи по идентификатору.", "operationId": "tasks_template_get", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/tasks-template-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "params": { "type": "object", "description": "| Дополнительные параметры выборки (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "params": { "type": "object", "description": "| Дополнительные параметры выборки (подробное описание) ||" }, "select": { "type": "array", "items": {}, "description": "| Массив полей, которые нужно вернуть." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.update": { "post": { "summary": "Обновить шаблон задачи tasks.template.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `tasks.template.update` обновляет существующий шаблон задачи.", "operationId": "tasks_template_update", "tags": [ "Задачи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/tasks/template/tasks-template-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "fields": { "type": "object", "description": "| Поля шаблона, которые нужно изменить." } }, "required": [ "templateId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Идентификатор шаблона задачи." }, "fields": { "type": "object", "description": "| Поля шаблона, которые нужно изменить." } }, "required": [ "templateId", "fields" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/telephony.call.attachTranscription": { "post": { "summary": "Добавить расшифровку записи к звонку telephony.call.attachTranscription", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.call.attachTranscription` добавляет расшифровку разговора к завершенному звонку.", "operationId": "telephony_call_attachTranscription", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-call-attach-transcription.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив реплик расшифровки. Каждый элемент массива — объект с полями реплики ||" }, "COST": { "type": "number", "format": "double", "description": "| Стоимость расшифровки." }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости расшифровки. Используется только вместе с `COST`." }, "SIDE": { "type": "string", "description": "| Участник разговора." }, "START_TIME": { "type": "integer", "description": "| Время начала реплики в секундах от начала звонка." }, "STOP_TIME": { "type": "integer", "description": "| Время окончания реплики в секундах от начала звонка." }, "MESSAGE": { "type": "string", "description": "| Текст реплики ||" } }, "required": [ "CALL_ID", "MESSAGES", "SIDE", "START_TIME", "STOP_TIME", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" }, "MESSAGES": { "type": "array", "items": {}, "description": "| Массив реплик расшифровки. Каждый элемент массива — объект с полями реплики ||" }, "COST": { "type": "number", "format": "double", "description": "| Стоимость расшифровки." }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости расшифровки. Используется только вместе с `COST`." }, "SIDE": { "type": "string", "description": "| Участник разговора." }, "START_TIME": { "type": "integer", "description": "| Время начала реплики в секундах от начала звонка." }, "STOP_TIME": { "type": "integer", "description": "| Время окончания реплики в секундах от начала звонка." }, "MESSAGE": { "type": "string", "description": "| Текст реплики ||" } }, "required": [ "CALL_ID", "MESSAGES", "SIDE", "START_TIME", "STOP_TIME", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.attachRecord": { "post": { "summary": "Прикрепить запись к завершенному звонку telephony.externalCall.attachRecord", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.attachRecord` прикрепляет запись к завершенному звонку и к CRM-делу звонка.", "operationId": "telephony_externalCall_attachRecord", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-attach-record.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register." }, "RECORD_URL": { "type": "string", "description": "| URL записи на внешнем сервере. Битрикс24 скачивает файл по ссылке. Если параметр передан, `FILE_CONTENT` не используется." }, "FILENAME": { "type": "string", "description": "| Имя файла записи. Обязательный, если не передан `RECORD_URL`." }, "FILE_CONTENT": { "type": "string", "description": "| Файл в кодировке Base64 ||" } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register." }, "RECORD_URL": { "type": "string", "description": "| URL записи на внешнем сервере. Битрикс24 скачивает файл по ссылке. Если параметр передан, `FILE_CONTENT` не используется." }, "FILENAME": { "type": "string", "description": "| Имя файла записи. Обязательный, если не передан `RECORD_URL`." }, "FILE_CONTENT": { "type": "string", "description": "| Файл в кодировке Base64 ||" } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.finish": { "post": { "summary": "Завершить звонок и зафиксировать его в статистике telephony.externalCall.finish", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.finish` завершает внешний звонок, сохраняет его в статистике и в CRM-деле.", "operationId": "telephony_externalCall_finish", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-finish.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, который завершает звонок." }, "USER_PHONE_INNER": { "type": "string", "description": "| Внутренний номер пользователя." }, "DURATION": { "type": "integer", "description": "| Длительность звонка в секундах." }, "COST": { "type": "number", "format": "double", "description": "| Стоимость звонка." }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости звонка." }, "STATUS_CODE": { "type": "string", "description": "| Код результата звонка." }, "FAILED_REASON": { "type": "string", "description": "| Текст причины несостоявшегося звонка." }, "RECORD_URL": { "type": "string", "description": "| URL записи звонка." }, "VOTE": { "type": "integer", "description": "| Оценка звонка." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Добавлять сообщение о звонке в чат сотрудника." } }, "required": [ "CALL_ID", "USER_ID", "USER_PHONE_INNER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, который завершает звонок." }, "USER_PHONE_INNER": { "type": "string", "description": "| Внутренний номер пользователя." }, "DURATION": { "type": "integer", "description": "| Длительность звонка в секундах." }, "COST": { "type": "number", "format": "double", "description": "| Стоимость звонка." }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости звонка." }, "STATUS_CODE": { "type": "string", "description": "| Код результата звонка." }, "FAILED_REASON": { "type": "string", "description": "| Текст причины несостоявшегося звонка." }, "RECORD_URL": { "type": "string", "description": "| URL записи звонка." }, "VOTE": { "type": "integer", "description": "| Оценка звонка." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Добавлять сообщение о звонке в чат сотрудника." } }, "required": [ "CALL_ID", "USER_ID", "USER_PHONE_INNER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.hide": { "post": { "summary": "Скрыть карточку звонка у пользователя telephony.externalCall.hide", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.hide` скрывает карточку звонка у пользователя или списка пользователей.", "operationId": "telephony_externalCall_hide", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-hide.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register. ||" } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register. ||" } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.register": { "post": { "summary": "Зарегистрировать звонок в Битрикс24 telephony.externalCall.register", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.register` регистрирует внешний звонок в Битрикс24.", "operationId": "telephony_externalCall_register", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-register.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого регистрируется звонок." }, "USER_PHONE_INNER": { "type": "string", "description": "| Внутренний номер пользователя." }, "PHONE_NUMBER": { "type": "string", "description": "| Номер телефона клиента ||" }, "TYPE": { "type": "integer", "description": "| Тип звонка." }, "CALL_START_DATE": { "type": "string", "description": "| Дата и время начала звонка в формате ISO-8601 с указанием часового пояса, например `2026-03-07T10:20:30+03:00`." }, "CRM_CREATE": { "type": "integer", "description": "| Автоматическое создание объекта CRM, если по номеру не найден подходящий объект." }, "CRM_SOURCE": { "type": "string", "description": "| Идентификатор источника CRM (значение поля `STATUS_ID`)." }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM, с которым нужно связать звонок." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта CRM из `CRM_ENTITY_TYPE`." }, "SHOW": { "type": "integer", "description": "| Показывать карточку звонка после регистрации." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Добавлять сообщение о звонке в чат сотрудника." }, "CALL_LIST_ID": { "type": "integer", "description": "| Идентификатор списка обзвона, к которому привязывается звонок." }, "LINE_NUMBER": { "type": "string", "description": "| Номер внешней линии." }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Внешний идентификатор звонка на стороне АТС/интеграции." } }, "required": [ "USER_ID", "USER_PHONE_INNER", "PHONE_NUMBER", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого регистрируется звонок." }, "USER_PHONE_INNER": { "type": "string", "description": "| Внутренний номер пользователя." }, "PHONE_NUMBER": { "type": "string", "description": "| Номер телефона клиента ||" }, "TYPE": { "type": "integer", "description": "| Тип звонка." }, "CALL_START_DATE": { "type": "string", "description": "| Дата и время начала звонка в формате ISO-8601 с указанием часового пояса, например `2026-03-07T10:20:30+03:00`." }, "CRM_CREATE": { "type": "integer", "description": "| Автоматическое создание объекта CRM, если по номеру не найден подходящий объект." }, "CRM_SOURCE": { "type": "string", "description": "| Идентификатор источника CRM (значение поля `STATUS_ID`)." }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM, с которым нужно связать звонок." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта CRM из `CRM_ENTITY_TYPE`." }, "SHOW": { "type": "integer", "description": "| Показывать карточку звонка после регистрации." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Добавлять сообщение о звонке в чат сотрудника." }, "CALL_LIST_ID": { "type": "integer", "description": "| Идентификатор списка обзвона, к которому привязывается звонок." }, "LINE_NUMBER": { "type": "string", "description": "| Номер внешней линии." }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Внешний идентификатор звонка на стороне АТС/интеграции." } }, "required": [ "USER_ID", "USER_PHONE_INNER", "PHONE_NUMBER", "TYPE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.searchCrmEntities": { "post": { "summary": "Найти клиента в CRM по номеру телефона telephony.externalCall.searchCrmEntities", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.searchCrmEntities` возвращает CRM-объекты по номеру телефона клиента и данные ответственного сотрудника. Среди лидов метод возвращает только доступный текущему пользователю активный лид.", "operationId": "telephony_externalCall_searchCrmEntities", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-search-crm-entities.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PHONE_NUMBER": { "type": "string", "description": "| Номер телефона клиента ||" } }, "required": [ "PHONE_NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PHONE_NUMBER": { "type": "string", "description": "| Номер телефона клиента ||" } }, "required": [ "PHONE_NUMBER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.show": { "post": { "summary": "Показать карточку звонка пользователю telephony.externalCall.show", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalCall.show` показывает карточку звонка пользователю или списку пользователей.", "operationId": "telephony_externalCall_show", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-call-show.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Идентификатор звонка из метода telephony.externalCall.register ||" } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.add": { "post": { "summary": "Добавить внешнюю линию telephony.externalLine.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalLine.add` добавляет внешнюю линию приложения.", "operationId": "telephony_externalLine_add", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-line-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Автосоздание объекта CRM при исходящих звонках." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Автосоздание объекта CRM при исходящих звонках." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.delete": { "post": { "summary": "Удалить внешнюю линию telephony.externalLine.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalLine.delete` удаляет внешнюю линию приложения.", "operationId": "telephony_externalLine_delete", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-line-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.get": { "post": { "summary": "Получить список внешних линий приложения telephony.externalLine.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalLine.get` возвращает список внешних линий приложения.", "operationId": "telephony_externalLine_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-line-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.update": { "post": { "summary": "Изменить внешнюю линию telephony.externalLine.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `telephony.externalLine.update` изменяет параметры внешней линии приложения.", "operationId": "telephony_externalLine_update", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/telephony-external-line-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии." }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Автосоздание объекта CRM при исходящих звонках." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| Номер внешней линии." }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Автосоздание объекта CRM при исходящих звонках." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/timeman.close": { "post": { "summary": "Завершить текущий день timeman.close", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.close` завершает текущий рабочий день.", "operationId": "timeman_close", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/base/timeman-close.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "TIME": { "type": "string", "format": "date-time", "description": "| Время и дата окончания рабочего дня в формате стандарта ATOM (ISO-8601), например, `2025-02-12T15:52:01+00:00`. Дата в часовом поясе сотрудника должна совпадать с датой начала рабочего дня." }, "REPORT": { "type": "string", "description": "| Причина изменения рабочего дня." }, "LAT": { "type": "number", "format": "double", "description": "| Географическая широта окончания рабочего дня ||" }, "LON": { "type": "number", "format": "double", "description": "| Географическая долгота окончания рабочего дня ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "TIME": { "type": "string", "format": "date-time", "description": "| Время и дата окончания рабочего дня в формате стандарта ATOM (ISO-8601), например, `2025-02-12T15:52:01+00:00`. Дата в часовом поясе сотрудника должна совпадать с датой начала рабочего дня." }, "REPORT": { "type": "string", "description": "| Причина изменения рабочего дня." }, "LAT": { "type": "number", "format": "double", "description": "| Географическая широта окончания рабочего дня ||" }, "LON": { "type": "number", "format": "double", "description": "| Географическая долгота окончания рабочего дня ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.check": { "post": { "summary": "Проверить IP-адрес timeman.networkrange.check", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.networkrange.check` проверяет IP-адрес на вхождение в диапазоны сетевых адресов офисной сети.", "operationId": "timeman_networkrange_check", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/networkrange/timeman-networkrange-check.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IP": { "type": "string", "description": "| IP-адрес, который нужно проверить. Например `10.10.255.255`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IP": { "type": "string", "description": "| IP-адрес, который нужно проверить. Например `10.10.255.255`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.get": { "post": { "summary": "Получить диапазон сетевых адресов timeman.networkrange.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.networkrange.get` получает диапазоны сетевых адресов офисной сети.", "operationId": "timeman_networkrange_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/networkrange/timeman-networkrange-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.set": { "post": { "summary": "Установить диапазон сетевых адресов timeman.networkrange.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.networkrange.set` устанавливает диапазоны сетевых адресов для офисной сети.", "operationId": "timeman_networkrange_set", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/networkrange/timeman-networkrange-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "RANGES": { "type": "array", "items": {}, "description": "| Диапазоны сетевых адресов в виде списка объектов. Каждый объект содержит описание диапазона сетевых адресов. Пустой массив очищает список диапазонов." } }, "required": [ "RANGES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "RANGES": { "type": "array", "items": {}, "description": "| Диапазоны сетевых адресов в виде списка объектов. Каждый объект содержит описание диапазона сетевых адресов. Пустой массив очищает список диапазонов." } }, "required": [ "RANGES" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.open": { "post": { "summary": "Начать новый рабочий день timeman.open", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.open` начинает новый рабочий день, или продолжает рабочий день после паузы или завершения.", "operationId": "timeman_open", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/base/timeman-open.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "TIME": { "type": "string", "format": "date-time", "description": "| Время и дата начала рабочего дня в формате стандарта ATOM (ISO-8601), например, `2025-02-12T15:52:01+00:00`. Дата должна совпадать с текущей датой в часовом поясе сотрудника." }, "REPORT": { "type": "string", "description": "| Причина изменения рабочего дня." }, "LAT": { "type": "number", "format": "double", "description": "| Географическая широта начала рабочего дня ||" }, "LON": { "type": "number", "format": "double", "description": "| Географическая долгота начала рабочего дня ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "TIME": { "type": "string", "format": "date-time", "description": "| Время и дата начала рабочего дня в формате стандарта ATOM (ISO-8601), например, `2025-02-12T15:52:01+00:00`. Дата должна совпадать с текущей датой в часовом поясе сотрудника." }, "REPORT": { "type": "string", "description": "| Причина изменения рабочего дня." }, "LAT": { "type": "number", "format": "double", "description": "| Географическая широта начала рабочего дня ||" }, "LON": { "type": "number", "format": "double", "description": "| Географическая долгота начала рабочего дня ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.pause": { "post": { "summary": "Приостановить текущий рабочий день timeman.pause", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.pause` приостанавливает открытый рабочий день. Продолжить день после паузы можно методом [timeman.open](./timeman-open.md).", "operationId": "timeman_pause", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/base/timeman-pause.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.record.field.get": { "post": { "summary": "Получить поле записи о рабочем времени timeman.record.field.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "timeman_record_field_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/record/timeman-record-field-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.record.field.list": { "post": { "summary": "Получить список полей записи о рабочем времени timeman.record.field.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "timeman_record_field_list", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/record/timeman-record-field-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Список полей описания, которые нужно вернуть в ответе." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.record.list": { "post": { "summary": "Получить список записей о рабочем времени timeman.record.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](../../rest-v3.md).", "operationId": "timeman_record_list", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/record/timeman-record-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`. Без параметра метод возвращает записи от новых к старым." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Условия фильтрации записей в формате:" }, "select": { "type": "array", "items": {}, "description": "| Список полей, которые нужно вернуть в ответе." }, "order": { "type": "object", "description": "| Сортировка результатов в формате `{ \"field\": \"value\" }`. Без параметра метод возвращает записи от новых к старым." }, "pagination": { "type": "object", "description": "| Параметры постраничной навигации:" } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.schedule.get": { "post": { "summary": "Получить рабочий график timeman.schedule.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.schedule.get` получает рабочий график по идентификатору. Если графика нет или `id` не число, метод вернет пустой массив без ошибки.", "operationId": "timeman_schedule_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/schedule/timeman-schedule-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор графика." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор графика." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.settings": { "post": { "summary": "Получить настройки рабочего времени пользователя timeman.settings", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.settings` получает настройки рабочего времени пользователя.", "operationId": "timeman_settings", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/base/timeman-settings.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.status": { "post": { "summary": "Получить информацию о текущем рабочем дне timeman.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.status` получает информацию о текущем рабочем дне.", "operationId": "timeman_status", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/base/timeman-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.report.add": { "post": { "summary": "Добавить отчет об отсутствии timeman.timecontrol.report.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.report.add` отправляет отчет об отсутствии. Если передать `CALENDAR: Y`, метод также добавит событие в календарь сотрудника.", "operationId": "timeman_timecontrol_report_add", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-report-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REPORT_ID": { "type": "string", "description": "\\| ID*" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя. Метод учитывает параметр, только если его вызвал администратор, в облачном Битрикс24 также интегратор. У остальных пользователей метод отправит отчет за них самих." }, "TEXT": { "type": "string", "description": "| Текст отчета ||" }, "TYPE": { "type": "string", "description": "| Тип отсутствия:" }, "CALENDAR": { "type": "string", "description": "| Добавлять событие в календарь:" } }, "required": [ "REPORT_ID", "TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REPORT_ID": { "type": "string", "description": "\\| ID*" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя. Метод учитывает параметр, только если его вызвал администратор, в облачном Битрикс24 также интегратор. У остальных пользователей метод отправит отчет за них самих." }, "TEXT": { "type": "string", "description": "| Текст отчета ||" }, "TYPE": { "type": "string", "description": "| Тип отсутствия:" }, "CALENDAR": { "type": "string", "description": "| Добавлять событие в календарь:" } }, "required": [ "REPORT_ID", "TEXT" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.get": { "post": { "summary": "Получить отчет о выявленных отсутствиях timeman.timecontrol.reports.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.reports.get` получает отчет о выявленных отсутствиях.", "operationId": "timeman_timecontrol_reports_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-reports-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого запрашиваются отчеты." }, "MONTH": { "type": "integer", "description": "| Номер месяца от `1` до `12`." }, "YEAR": { "type": "integer", "description": "| Год." }, "IDLE_MINUTES": { "type": "integer", "description": "| Порог в минутах: отсутствия такой длительности и короче метод не включает в отчет." }, "WORKDAY_HOURS": { "type": "integer", "description": "| Продолжительность рабочего дня в часах. По ней метод вычисляет недоработку за день ||" } }, "required": [ "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, для которого запрашиваются отчеты." }, "MONTH": { "type": "integer", "description": "| Номер месяца от `1` до `12`." }, "YEAR": { "type": "integer", "description": "| Год." }, "IDLE_MINUTES": { "type": "integer", "description": "| Порог в минутах: отсутствия такой длительности и короче метод не включает в отчет." }, "WORKDAY_HOURS": { "type": "integer", "description": "| Продолжительность рабочего дня в часах. По ней метод вычисляет недоработку за день ||" } }, "required": [ "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.settings.get": { "post": { "summary": "Получить настройки отчетов timeman.timecontrol.reports.settings.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.reports.settings.get` получает настройки отчетов для построения интерфейса отчетов инструмента контроля времени.", "operationId": "timeman_timecontrol_reports_settings_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-reports-settings-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.users.get": { "post": { "summary": "Получить список пользователей подразделения timeman.timecontrol.reports.users.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.reports.users.get` получает список пользователей подразделения.", "operationId": "timeman_timecontrol_reports_users_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-reports-users-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DEPARTMENT_ID": { "type": "integer", "description": "| Идентификатор подразделения. Параметр нужно указывать только руководителю или администратору." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DEPARTMENT_ID": { "type": "integer", "description": "| Идентификатор подразделения. Параметр нужно указывать только руководителю или администратору." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.settings.get": { "post": { "summary": "Получить настройки контроля времени timeman.timecontrol.settings.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.settings.get` получает настройки контроля времени. Изменить настройки можно методом [timeman.timecontrol.settings.set](./timeman-timecontrol-settings-set.md).", "operationId": "timeman_timecontrol_settings_get", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-settings-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.settings.set": { "post": { "summary": "Установить настройки контроля времени timeman.timecontrol.settings.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `timeman.timecontrol.settings.set` устанавливает настройки контроля времени. Передавайте только те настройки, которые нужно изменить: остальные метод оставит как есть. Текущие значения возвращает метод [timeman.timecontrol.settings.get](./timeman-timecontrol-settings-get.md).", "operationId": "timeman_timecontrol_settings_set", "tags": [ "Учёт рабочего времени" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/timeman/timecontrol/timeman-timecontrol-settings-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "boolean", "description": "| Включает и выключает контроль времени. Возможные значения:" }, "MINIMUM_IDLE_FOR_REPORT": { "type": "integer", "description": "| Минимальное время отсутствия в минутах, после которого требуется отчет. Значение `0` и меньше метод сохранит как `1` ||" }, "REGISTER_OFFLINE": { "type": "boolean", "description": "| Регистрировать офлайн статус ||" }, "REGISTER_IDLE": { "type": "boolean", "description": "| Регистрировать статус Отошел ||" }, "REGISTER_DESKTOP": { "type": "boolean", "description": "| Регистрировать статус десктоп приложения ||" }, "REPORT_REQUEST_TYPE": { "type": "string", "description": "| Тип запроса отчетов. Возможные значения:" }, "REPORT_REQUEST_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, для которых требуется запрос отчетов." }, "REPORT_SIMPLE_TYPE": { "type": "string", "description": "| Тип простого отчета. Возможные значения:" }, "REPORT_SIMPLE_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей с доступом к простому отчету." }, "REPORT_FULL_TYPE": { "type": "string", "description": "| Тип полного отчета. Возможные значения:" }, "REPORT_FULL_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей с доступом к полному отчету." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "boolean", "description": "| Включает и выключает контроль времени. Возможные значения:" }, "MINIMUM_IDLE_FOR_REPORT": { "type": "integer", "description": "| Минимальное время отсутствия в минутах, после которого требуется отчет. Значение `0` и меньше метод сохранит как `1` ||" }, "REGISTER_OFFLINE": { "type": "boolean", "description": "| Регистрировать офлайн статус ||" }, "REGISTER_IDLE": { "type": "boolean", "description": "| Регистрировать статус Отошел ||" }, "REGISTER_DESKTOP": { "type": "boolean", "description": "| Регистрировать статус десктоп приложения ||" }, "REPORT_REQUEST_TYPE": { "type": "string", "description": "| Тип запроса отчетов. Возможные значения:" }, "REPORT_REQUEST_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей, для которых требуется запрос отчетов." }, "REPORT_SIMPLE_TYPE": { "type": "string", "description": "| Тип простого отчета. Возможные значения:" }, "REPORT_SIMPLE_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей с доступом к простому отчету." }, "REPORT_FULL_TYPE": { "type": "string", "description": "| Тип полного отчета. Возможные значения:" }, "REPORT_FULL_USERS": { "type": "array", "items": {}, "description": "| Массив идентификаторов пользователей с доступом к полному отчету." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/user.access": { "post": { "summary": "Проверить коды доступа пользователя user.access", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.access` проверяет, есть ли у текущего пользователя хотя бы один из кодов доступа, переданных в параметре `ACCESS`.", "operationId": "user_access", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/users/user-access.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "string", "description": "\\|`string` | Список кодов доступа, которые нужно проверить, например `[\"D1\", \"SG1_K\"]`. Один код можно передать строкой, например `\"D1\"`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "string", "description": "\\|`string` | Список кодов доступа, которые нужно проверить, например `[\"D1\", \"SG1_K\"]`. Один код можно передать строкой, например `\"D1\"`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/user.add": { "post": { "summary": "Добавить пользователей в группу sonet_group.user.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.add` добавляет пользователей в рабочую группу или проект без приглашения и подтверждения.", "operationId": "user_add", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "GROUP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "GROUP_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.admin": { "post": { "summary": "Проверить права администратора user.admin", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.admin` проверяет, является ли текущий пользователь администратором Битрикс24.", "operationId": "user_admin", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/users/user-admin.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/user.current": { "post": { "summary": "Получить информацию о текущем пользователе user.current", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.current` возвращает профиль пользователя, чей токен использован в запросе: для сохраненного токена администратора это администратор, для токена из фрейма приложения — пользователь, который открыл приложение.", "operationId": "user_current", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/user-current.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.delete": { "post": { "summary": "Удалить пользователей из группы sonet_group.user.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.delete` удаляет участников из рабочей группы или проекта.", "operationId": "user_delete", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "GROUP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "GROUP_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.fields": { "post": { "summary": "Получить поля пользователя user.fields", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.fields` возвращает коды и названия полей профиля пользователя: стандартных и пользовательских полей с префиксом `UF_USR_`.", "operationId": "user_fields", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/user-fields.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.get": { "post": { "summary": "Получить список участников группы sonet_group.user.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.get` возвращает список активных участников рабочей группы или проекта.", "operationId": "user_get", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.groups": { "post": { "summary": "Получить список групп текущего пользователя sonet_group.user.groups", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.groups` возвращает группы и проекты, в которых состоит текущий пользователь.", "operationId": "user_groups", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/sonet-group-user-groups.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.invite": { "post": { "summary": "Пригласить пользователей в группу sonet_group.user.invite", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.invite` отправляет приглашения пользователям в рабочую группу или проект.", "operationId": "user_invite", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-invite.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "MESSAGE": { "type": "string", "description": "| Текст приглашения ||" } }, "required": [ "GROUP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "MESSAGE": { "type": "string", "description": "| Текст приглашения ||" } }, "required": [ "GROUP_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.option.get": { "post": { "summary": "Получить настройки пользователя user.option.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.option.get` получает настройки текущего пользователя, сохраненные приложением через [user.option.set](./user-option-set.md). Каждый пользователь видит только свои значения. Настройки других пользователей метод не возвращает, общие настройки приложения читает метод [app.option.get](./app-option-get.md).", "operationId": "user_option_get", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/settings/user-option-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| Один из ключей, сохраненных методом user.option.set." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| Один из ключей, сохраненных методом user.option.set." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/user.option.set": { "post": { "summary": "Сохранить настройки пользователя user.option.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.option.set` сохраняет настройки текущего пользователя для приложения. Каждый пользователь хранит свои значения. Прочитать их можно методом [user.option.get](./user-option-get.md).", "operationId": "user_option_set", "tags": [ "Общие методы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/common/settings/user-option-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "object", "description": "| Объект настроек: ключ — название настройки, значение — ее значение. Передавайте `options` объектом. Не используйте ключи `next` и `total`: при чтении всех настроек REST API вернет их не в `result`, а в корне ответа." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "options": { "type": "object", "description": "| Объект настроек: ключ — название настройки, значение — ее значение. Передавайте `options` объектом. Не используйте ключи `next` и `total`: при чтении всех настроек REST API вернет их не в `result`, а в корне ответа." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "базовый" ] } ] } }, "/user.request": { "post": { "summary": "Отправить запрос на вступление в группу sonet_group.user.request", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.request` отправляет запрос текущего пользователя на вступление в рабочую группу или проект.", "operationId": "user_request", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-request.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "MESSAGE": { "type": "string", "description": "| Текст запроса на вступление ||" } }, "required": [ "GROUP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "MESSAGE": { "type": "string", "description": "| Текст запроса на вступление ||" } }, "required": [ "GROUP_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.search": { "post": { "summary": "Получить список пользователей с поиском по персональным данным user.search", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.search` ищет пользователей по имени, фамилии, отчеству, названию подразделения и должности.", "operationId": "user_search", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/user-search.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект с полями поиска (подробное описание) ||" }, "sort": { "type": "string", "description": "| Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add." }, "order": { "type": "string", "description": "| Направление сортировки:" }, "ADMIN_MODE": { "type": "boolean", "description": "| Включает режим администратора для получения данных о пользователях. Параметр действует, только если запрос выполняет администратор." }, "select": { "type": "array", "items": {}, "description": "| Массив с названиями полей, которые вернутся в ответе. Без этого параметра метод возвращает все поля, доступные скоупу приложения или вебхука." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "FIND": { "type": "string", "description": "| Строка для поиска одновременно по имени, фамилии, отчеству, должности и названию подразделения ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия пользователя ||" }, "SECOND_NAME": { "type": "string", "description": "| Отчество пользователя ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность пользователя ||" }, "UF_DEPARTMENT_NAME": { "type": "string", "description": "| Название подразделения ||" }, "USER_TYPE": { "type": "string", "description": "| Тип пользователя. Возможные значения:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект с полями поиска (подробное описание) ||" }, "sort": { "type": "string", "description": "| Поле, по которому сортируются результаты. Сортировка работает по всем полям из user.add." }, "order": { "type": "string", "description": "| Направление сортировки:" }, "ADMIN_MODE": { "type": "boolean", "description": "| Включает режим администратора для получения данных о пользователях. Параметр действует, только если запрос выполняет администратор." }, "select": { "type": "array", "items": {}, "description": "| Массив с названиями полей, которые вернутся в ответе. Без этого параметра метод возвращает все поля, доступные скоупу приложения или вебхука." }, "start": { "type": "integer", "description": "| Параметр используется для управления постраничной навигацией." }, "FIND": { "type": "string", "description": "| Строка для поиска одновременно по имени, фамилии, отчеству, должности и названию подразделения ||" }, "LAST_NAME": { "type": "string", "description": "| Фамилия пользователя ||" }, "SECOND_NAME": { "type": "string", "description": "| Отчество пользователя ||" }, "WORK_POSITION": { "type": "string", "description": "| Должность пользователя ||" }, "UF_DEPARTMENT_NAME": { "type": "string", "description": "| Название подразделения ||" }, "USER_TYPE": { "type": "string", "description": "| Тип пользователя. Возможные значения:" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.update": { "post": { "summary": "Изменить роль участников группы sonet_group.user.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `sonet_group.user.update` изменяет роль участников рабочей группы или проекта.", "operationId": "user_update", "tags": [ "Рабочие группы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/sonet-group/members/sonet-group-user-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "ROLE": { "type": "string", "description": "| Код новой роли участника." } }, "required": [ "GROUP_ID", "ROLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Идентификатор рабочей группы или проекта." }, "ROLE": { "type": "string", "description": "| Код новой роли участника." } }, "required": [ "GROUP_ID", "ROLE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.userfield.add": { "post": { "summary": "Добавить пользовательское поле user.userfield.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.userfield.add` создает пользовательское поле в профиле сотрудника и возвращает его идентификатор. К коду `FIELD_NAME` автоматически добавляется префикс `UF_USR_`, тип и множественность поля после создания изменить нельзя.", "operationId": "user_userfield_add", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/userfields/user-userfield-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для добавления нового пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Название (код) поля. Битрикс24 приводит его к верхнему регистру и дополняет префиксом `UF_USR_`:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. После создания тип изменить нельзя. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки ||" }, "MULTIPLE": { "type": "string", "description": "| Является ли поле множественным. После создания изменить нельзя. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки поля. Набор зависит от типа `USER_TYPE_ID` (подробное описание) ||" }, "LIST": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` (подробное описание) ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\| `object` | Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\| `object` | Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\| `object` | Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "ERROR_MESSAGE": { "type": "string", "description": "\\| `object` | Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\| `object` | Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "VALUE": { "type": "string", "description": "| Текст варианта. Варианты с пустым `VALUE` не сохраняются ||" }, "DEF": { "type": "string", "description": "| Вариант по умолчанию:" } }, "required": [ "fields", "FIELD_NAME", "USER_TYPE_ID", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Значения полей для добавления нового пользовательского поля ||" }, "FIELD_NAME": { "type": "string", "description": "| Название (код) поля. Битрикс24 приводит его к верхнему регистру и дополняет префиксом `UF_USR_`:" }, "USER_TYPE_ID": { "type": "string", "description": "| Тип пользовательского поля. После создания тип изменить нельзя. Возможные значения:" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки ||" }, "MULTIPLE": { "type": "string", "description": "| Является ли поле множественным. После создания изменить нельзя. Возможные значения:" }, "SHOW_FILTER": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки поля. Набор зависит от типа `USER_TYPE_ID` (подробное описание) ||" }, "LIST": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` (подробное описание) ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\| `object` | Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\| `object` | Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\| `object` | Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "ERROR_MESSAGE": { "type": "string", "description": "\\| `object` | Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\| `object` | Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "VALUE": { "type": "string", "description": "| Текст варианта. Варианты с пустым `VALUE` не сохраняются ||" }, "DEF": { "type": "string", "description": "| Вариант по умолчанию:" } }, "required": [ "fields", "FIELD_NAME", "USER_TYPE_ID", "VALUE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.delete": { "post": { "summary": "Удалить пользовательское поле user.userfield.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.userfield.delete` удаляет пользовательское поле профиля вместе со значениями у всех сотрудников.", "operationId": "user_userfield_delete", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/userfields/user-userfield-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.file.get": { "post": { "summary": "Получить файл из пользовательского поля user.userfield.file.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации страница скрыта из меню, метод не работает", "operationId": "user_userfield_file_get", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/userfields/user-userfield-file-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.list": { "post": { "summary": "Получить список пользовательских полей user.userfield.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.userfield.list` получает список пользовательских полей по фильтру.", "operationId": "user_userfield_list", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/userfields/user-userfield-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "items": {}, "description": "| Сортировка выбранных пользовательских полей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр выбранных пользовательских полей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "array", "items": {}, "description": "| Сортировка выбранных пользовательских полей в формате `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Фильтр выбранных пользовательских полей в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.update": { "post": { "summary": "Обновить пользовательское поле user.userfield.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `user.userfield.update` изменяет настройки и подписи пользовательского поля профиля. Код `FIELD_NAME`, тип `USER_TYPE_ID` и множественность `MULTIPLE` после создания изменить нельзя.", "operationId": "user_userfield_update", "tags": [ "Пользователи" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user/userfields/user-userfield-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Настройки поля, которые нужно изменить (подробное описание). Непереданные настройки и подписи сохраняют текущие значения. Если `fields` не передан, метод ничего не меняет и возвращает `true` ||" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки ||" }, "SHOW_FILTER": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки поля. Набор зависит от типа поля (подробное описание)." }, "LIST": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` (подробное описание) ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\| `object` | Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\| `object` | Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\| `object` | Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "ERROR_MESSAGE": { "type": "string", "description": "\\| `object` | Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\| `object` | Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "ID": { "type": "integer", "description": "| Идентификатор существующего варианта. Его возвращает метод user.userfield.list в массиве `LIST`. Без `ID` вариант добавляется как новый ||" }, "VALUE": { "type": "string", "description": "| Текст варианта ||" }, "DEF": { "type": "string", "description": "| Вариант по умолчанию:" }, "DEL": { "type": "string", "description": "| Удалить вариант с указанным `ID`:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор пользовательского поля." }, "fields": { "type": "object", "description": "| Настройки поля, которые нужно изменить (подробное описание). Непереданные настройки и подписи сохраняют текущие значения. Если `fields` не передан, метод ничего не меняет и возвращает `true` ||" }, "XML_ID": { "type": "string", "description": "| Внешний код ||" }, "SORT": { "type": "integer", "description": "| Порядок сортировки ||" }, "SHOW_FILTER": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения:" }, "SETTINGS": { "type": "object", "description": "| Дополнительные настройки поля. Набор зависит от типа поля (подробное описание)." }, "LIST": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` (подробное описание) ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\| `object` | Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\| `object` | Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\| `object` | Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "ERROR_MESSAGE": { "type": "string", "description": "\\| `object` | Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\| `object` | Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате `{\"ru\": \"...\", \"en\": \"...\"}`. При передаче строки значение будет выставлено для всех языков ||" }, "LABEL": { "type": "string", "description": "| Название пользовательского поля по умолчанию." }, "ID": { "type": "integer", "description": "| Идентификатор существующего варианта. Его возвращает метод user.userfield.list в массиве `LIST`. Без `ID` вариант добавляется как новый ||" }, "VALUE": { "type": "string", "description": "| Текст варианта ||" }, "DEF": { "type": "string", "description": "| Вариант по умолчанию:" }, "DEL": { "type": "string", "description": "| Удалить вариант с указанным `ID`:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/userconsent.agreement.list": { "post": { "summary": "Получить список соглашений userconsent.agreement.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userconsent.agreement.list` возвращает список соглашений.", "operationId": "userconsent_agreement_list", "tags": [ "Соглашения" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user-consent/user-consent-agreement-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userconsent.agreement.text": { "post": { "summary": "Получить текст соглашения userconsent.agreement.text", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userconsent.agreement.text` возвращает текст соглашения.", "operationId": "userconsent_agreement_text", "tags": [ "Соглашения" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user-consent/user-consent-agreement-text.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор соглашения." }, "replace": { "type": "object", "description": "| Массив замен для подстановки текста. Доступные ключи:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Идентификатор соглашения." }, "replace": { "type": "object", "description": "| Массив замен для подстановки текста. Доступные ключи:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userconsent.consent.add": { "post": { "summary": "Сохранить полученное согласие пользователя userconsent.consent.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userconsent.consent.add` сохраняет полученное согласие пользователя.", "operationId": "userconsent_consent_add", "tags": [ "Соглашения" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/user-consent/user-consent-consent-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "AGREEMENT_ID": { "type": "integer", "description": "| Идентификатор соглашения." }, "IP": { "type": "string", "description": "| IP-адрес пользователя ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "URL": { "type": "string", "description": "| URL страницы, где было получено согласие ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор источника, например, `my_contact_form` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор элемента в источнике, например, e-mail ||" } }, "required": [ "AGREEMENT_ID", "IP" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "AGREEMENT_ID": { "type": "integer", "description": "| Идентификатор соглашения." }, "IP": { "type": "string", "description": "| IP-адрес пользователя ||" }, "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "URL": { "type": "string", "description": "| URL страницы, где было получено согласие ||" }, "ORIGIN_ID": { "type": "string", "description": "| Идентификатор источника, например, `my_contact_form` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Идентификатор элемента в источнике, например, e-mail ||" } }, "required": [ "AGREEMENT_ID", "IP" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userfieldconfig.add": { "post": { "summary": "Добавить пользовательское поле userfieldconfig.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.add` добавляет новое пользовательское поле.", "operationId": "userfieldconfig_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором создается поле ||" }, "field": { "type": "object", "description": "| Объект с настройками пользовательского поля (подробное описание) ||" }, "entityId": { "type": "string", "description": "| Идентификатор объекта, для которого создается поле. Формат зависит от модуля, например `CRM_7` для смарт-процесса ||" }, "fieldName": { "type": "string", "description": "| Код поля в формате `UF_{ИДЕНТИФИКАТОР_ОБЪЕКТА}_{POSTFIX}`. Код должен быть уникальным в рамках объекта. Допустимы символы `A-Z`, `0-9`, `_`. Максимальная длина кода 50 символов ||" }, "userTypeId": { "type": "string", "description": "| Идентификатор типа поля. Список доступных типов возвращает метод userfieldconfig.getTypes ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор поля ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки. По умолчанию `100` ||" }, "multiple": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "mandatory": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "showFilter": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "editInList": { "type": "boolean", "description": "| Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N` ||" }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N` ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки поля. Набор ключей зависит от `userTypeId` (подробное описание) ||" }, "editFormLabel": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования. При передаче строки используется как общее значение, при передаче `lang_map` можно задать подпись по языкам ||" }, "helpMessage": { "type": "string", "description": "\\|`lang_map` | Текст подсказки. При передаче строки используется как общее значение, при передаче `lang_map` можно задать подсказку по языкам ||" }, "enum": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор типа справочника CRM. Возможные значения можно получить методом `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Значение варианта списка ||" }, "def": { "type": "boolean", "description": "| Флаг значения по умолчанию (`Y`/`N`) ||" } }, "required": [ "moduleId", "field", "entityId", "fieldName", "userTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором создается поле ||" }, "field": { "type": "object", "description": "| Объект с настройками пользовательского поля (подробное описание) ||" }, "entityId": { "type": "string", "description": "| Идентификатор объекта, для которого создается поле. Формат зависит от модуля, например `CRM_7` для смарт-процесса ||" }, "fieldName": { "type": "string", "description": "| Код поля в формате `UF_{ИДЕНТИФИКАТОР_ОБЪЕКТА}_{POSTFIX}`. Код должен быть уникальным в рамках объекта. Допустимы символы `A-Z`, `0-9`, `_`. Максимальная длина кода 50 символов ||" }, "userTypeId": { "type": "string", "description": "| Идентификатор типа поля. Список доступных типов возвращает метод userfieldconfig.getTypes ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор поля ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки. По умолчанию `100` ||" }, "multiple": { "type": "boolean", "description": "| Является ли поле множественным. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "mandatory": { "type": "boolean", "description": "| Является ли поле обязательным. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "showFilter": { "type": "boolean", "description": "| Показывать ли поле в фильтре. Возможные значения: `Y` или `N`. По умолчанию `N` ||" }, "editInList": { "type": "boolean", "description": "| Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N` ||" }, "isSearchable": { "type": "boolean", "description": "| Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N` ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки поля. Набор ключей зависит от `userTypeId` (подробное описание) ||" }, "editFormLabel": { "type": "string", "description": "\\|`lang_map` | Подпись в форме редактирования. При передаче строки используется как общее значение, при передаче `lang_map` можно задать подпись по языкам ||" }, "helpMessage": { "type": "string", "description": "\\|`lang_map` | Текст подсказки. При передаче строки используется как общее значение, при передаче `lang_map` можно задать подсказку по языкам ||" }, "enum": { "type": "string", "description": "| Варианты значений для поля типа `enumeration` ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор типа справочника CRM. Возможные значения можно получить методом `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Значение варианта списка ||" }, "def": { "type": "boolean", "description": "| Флаг значения по умолчанию (`Y`/`N`) ||" } }, "required": [ "moduleId", "field", "entityId", "fieldName", "userTypeId", "value" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.delete": { "post": { "summary": "Удалить пользовательское поле userfieldconfig.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.delete` удаляет пользовательское поле.", "operationId": "userfieldconfig_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором удаляется поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля." } }, "required": [ "moduleId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором удаляется поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля." } }, "required": [ "moduleId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.get": { "post": { "summary": "Получить настройки пользовательского поля userfieldconfig.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.get` возвращает настройки пользовательского поля по его идентификатору.", "operationId": "userfieldconfig_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором находится поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля." } }, "required": [ "moduleId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором находится поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля." } }, "required": [ "moduleId", "id" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.getTypes": { "post": { "summary": "Получить доступные типы пользовательских полей userfieldconfig.getTypes", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.getTypes` возвращает набор доступных типов пользовательских полей для модуля.", "operationId": "userfieldconfig_getTypes", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-get-types.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, для которого нужно получить доступные типы полей ||" } }, "required": [ "moduleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, для которого нужно получить доступные типы полей ||" } }, "required": [ "moduleId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.list": { "post": { "summary": "Получить список настроек пользовательских полей userfieldconfig.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.list` возвращает список настроек пользовательских полей по фильтру.", "operationId": "userfieldconfig_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором выполняется поиск полей ||" }, "select": { "type": "object", "description": "| Набор полей, которые нужно вернуть (подробное описание). Имена полей можно передавать в camelCase, например `fieldName`, или в верхнем регистре, например `FIELD_NAME` ||" }, "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Смещение для постраничной выборки." }, "language": { "type": "string", "description": "| Языковой идентификатор, например `ru` или `en`. Передается как ключ объекта: `\"language\": \"ru\"`. Если параметр передан, метод возвращает языковые поля на выбранном языке:" }, "id": { "type": "string", "description": "| Идентификатор настройки поля ||" }, "entityId": { "type": "string", "description": "| Идентификатор объекта ||" }, "fieldName": { "type": "string", "description": "| Код поля ||" }, "userTypeId": { "type": "string", "description": "| Тип поля ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "sort": { "type": "string", "description": "| Индекс сортировки ||" }, "multiple": { "type": "string", "description": "| Является ли пользовательское поле множественным. Возможные значения: `Y` или `N` ||" }, "mandatory": { "type": "string", "description": "| Является ли пользовательское поле обязательным. Возможные значения: `Y` или `N` ||" }, "showFilter": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения: `N`, `I`, `E`, `S` ||" }, "showInList": { "type": "string", "description": "| Показывать ли поле в списке. Возможные значения: `Y` или `N` ||" }, "editInList": { "type": "string", "description": "| Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N` ||" }, "isSearchable": { "type": "string", "description": "| Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N` ||" }, "settings": { "type": "string", "description": "| Дополнительные настройки поля ||" } }, "required": [ "moduleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором выполняется поиск полей ||" }, "select": { "type": "object", "description": "| Набор полей, которые нужно вернуть (подробное описание). Имена полей можно передавать в camelCase, например `fieldName`, или в верхнем регистре, например `FIELD_NAME` ||" }, "order": { "type": "object", "description": "| Объект формата:" }, "filter": { "type": "object", "description": "| Объект формата:" }, "start": { "type": "integer", "description": "| Смещение для постраничной выборки." }, "language": { "type": "string", "description": "| Языковой идентификатор, например `ru` или `en`. Передается как ключ объекта: `\"language\": \"ru\"`. Если параметр передан, метод возвращает языковые поля на выбранном языке:" }, "id": { "type": "string", "description": "| Идентификатор настройки поля ||" }, "entityId": { "type": "string", "description": "| Идентификатор объекта ||" }, "fieldName": { "type": "string", "description": "| Код поля ||" }, "userTypeId": { "type": "string", "description": "| Тип поля ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор ||" }, "sort": { "type": "string", "description": "| Индекс сортировки ||" }, "multiple": { "type": "string", "description": "| Является ли пользовательское поле множественным. Возможные значения: `Y` или `N` ||" }, "mandatory": { "type": "string", "description": "| Является ли пользовательское поле обязательным. Возможные значения: `Y` или `N` ||" }, "showFilter": { "type": "string", "description": "| Показывать ли поле в фильтре списка. Возможные значения: `N`, `I`, `E`, `S` ||" }, "showInList": { "type": "string", "description": "| Показывать ли поле в списке. Возможные значения: `Y` или `N` ||" }, "editInList": { "type": "string", "description": "| Разрешать ли редактирование значения в списке. Возможные значения: `Y` или `N` ||" }, "isSearchable": { "type": "string", "description": "| Участвуют ли значения поля в поиске. Возможные значения: `Y` или `N` ||" }, "settings": { "type": "string", "description": "| Дополнительные настройки поля ||" } }, "required": [ "moduleId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.update": { "post": { "summary": "Обновить пользовательское поле userfieldconfig.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldconfig.update` обновляет настройки существующего пользовательского поля.", "operationId": "userfieldconfig_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором находится поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля ||" }, "field": { "type": "object", "description": "| Объект с новыми настройками поля (подробное описание) ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор поля ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "mandatory": { "type": "boolean", "description": "| Флаг обязательного поля (`Y`/`N`) ||" }, "showFilter": { "type": "boolean", "description": "| Флаг показа поля в фильтре (`Y`/`N`) ||" }, "isSearchable": { "type": "boolean", "description": "| Флаг участия поля в поиске (`Y`/`N`) ||" }, "editFormLabel": { "type": "string", "description": "| Подписи в форме редактирования по языкам ||" }, "helpMessage": { "type": "string", "description": "| Текст подсказки по языкам ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки поля. Набор ключей зависит от типа поля (подробное описание) ||" }, "enum": { "type": "string", "description": "| Список вариантов значений для поля типа `enumeration`." }, "userTypeId": { "type": "string", "description": "| Тип поля." }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор типа справочника CRM. Возможные значения можно получить методом `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Значение варианта ||" }, "def": { "type": "boolean", "description": "| Флаг значения по умолчанию (`Y`/`N`) ||" }, "del": { "type": "boolean", "description": "| Флаг удаления существующего варианта (`Y`/`N`) ||" } }, "required": [ "moduleId", "id", "field" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, в котором находится поле ||" }, "id": { "type": "integer", "description": "| Идентификатор настроек пользовательского поля ||" }, "field": { "type": "object", "description": "| Объект с новыми настройками поля (подробное описание) ||" }, "xmlId": { "type": "string", "description": "| Внешний идентификатор поля ||" }, "sort": { "type": "integer", "description": "| Индекс сортировки ||" }, "mandatory": { "type": "boolean", "description": "| Флаг обязательного поля (`Y`/`N`) ||" }, "showFilter": { "type": "boolean", "description": "| Флаг показа поля в фильтре (`Y`/`N`) ||" }, "isSearchable": { "type": "boolean", "description": "| Флаг участия поля в поиске (`Y`/`N`) ||" }, "editFormLabel": { "type": "string", "description": "| Подписи в форме редактирования по языкам ||" }, "helpMessage": { "type": "string", "description": "| Текст подсказки по языкам ||" }, "settings": { "type": "object", "description": "| Дополнительные настройки поля. Набор ключей зависит от типа поля (подробное описание) ||" }, "enum": { "type": "string", "description": "| Список вариантов значений для поля типа `enumeration`." }, "userTypeId": { "type": "string", "description": "| Тип поля." }, "ENTITY_TYPE": { "type": "string", "description": "| Идентификатор типа справочника CRM. Возможные значения можно получить методом `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Значение варианта ||" }, "def": { "type": "boolean", "description": "| Флаг значения по умолчанию (`Y`/`N`) ||" }, "del": { "type": "boolean", "description": "| Флаг удаления существующего варианта (`Y`/`N`) ||" } }, "required": [ "moduleId", "id", "field" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldtype.add": { "post": { "summary": "Зарегистрировать новый тип пользовательских полей userfieldtype.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldtype.add` регистрирует тип пользовательских полей приложения и работает только в контексте [приложения](../../../settings/app-installation/index.md). После регистрации создайте поле этого типа методом [userfieldconfig.add](../../crm/universal/userfieldconfig/userfieldconfig-add.md): в `field.userTypeId` передайте полный код `rest__`, где `APP_ID` — идентификатор приложения из метода [app.info](../../common/system/app-info.md). Чтобы создать поле, приложению нужны еще scope `userfieldconfig` и `crm`.", "operationId": "userfieldtype_add", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/user-field/userfieldtype-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Код типа. Метод приводит его к нижнему регистру." }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, который Битрикс24 загрузит в поле. Он должен начинаться с `http://` или `https://`, а имя хоста — содержать точку." }, "TITLE": { "type": "string", "description": "| Название типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей. Если не передать, названием станет код типа ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей ||" }, "OPTIONS": { "type": "object", "description": "| Дополнительные настройки. Сейчас доступен один ключ: `height` — высота поля в пикселях, целое число." }, "LANG_ALL": { "type": "object", "description": "| Название и описание типа для разных языков. Ключ объекта — двухбуквенный код языка, например `ru` или `en`. Значение — объект со строковыми полями `TITLE` и `DESCRIPTION` до 255 символов. Если передан непустой `LANG_ALL`, метод не учитывает параметры `TITLE` и `DESCRIPTION`." } }, "required": [ "USER_TYPE_ID", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Код типа. Метод приводит его к нижнему регистру." }, "HANDLER": { "type": "string", "description": "| Адрес обработчика, который Битрикс24 загрузит в поле. Он должен начинаться с `http://` или `https://`, а имя хоста — содержать точку." }, "TITLE": { "type": "string", "description": "| Название типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей. Если не передать, названием станет код типа ||" }, "DESCRIPTION": { "type": "string", "description": "| Описание типа до 255 символов. Выводится в административном интерфейсе настройки пользовательских полей ||" }, "OPTIONS": { "type": "object", "description": "| Дополнительные настройки. Сейчас доступен один ключ: `height` — высота поля в пикселях, целое число." }, "LANG_ALL": { "type": "object", "description": "| Название и описание типа для разных языков. Ключ объекта — двухбуквенный код языка, например `ru` или `en`. Значение — объект со строковыми полями `TITLE` и `DESCRIPTION` до 255 символов. Если передан непустой `LANG_ALL`, метод не учитывает параметры `TITLE` и `DESCRIPTION`." } }, "required": [ "USER_TYPE_ID", "HANDLER" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/userfieldtype.delete": { "post": { "summary": "Удалить зарегистрированный тип пользовательских полей userfieldtype.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldtype.delete` удаляет тип пользовательских полей, который зарегистрировало это приложение, и работает только в контексте [приложения](../../../settings/app-installation/index.md). Чтобы сменить адрес обработчика, название, описание или высоту поля, удалять тип не нужно — используйте метод [userfieldtype.update](./userfieldtype-update.md).", "operationId": "userfieldtype_delete", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/user-field/userfieldtype-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Код типа, который приложение передало в userfieldtype.add. Регистр не важен. Получить коды можно методом userfieldtype.list ||" } }, "required": [ "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Код типа, который приложение передало в userfieldtype.add. Регистр не важен. Получить коды можно методом userfieldtype.list ||" } }, "required": [ "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/userfieldtype.list": { "post": { "summary": "Получить список зарегистрированных типов пользовательских полей userfieldtype.list", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldtype.list` возвращает типы пользовательских полей, которые приложение зарегистрировало методом [userfieldtype.add](./userfieldtype-add.md). Для каждого типа метод отдает код, адрес обработчика, название и описание.", "operationId": "userfieldtype_list", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/user-field/userfieldtype-list.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает не более 50 записей за вызов. Чтобы получить следующую страницу, передайте значение `next` из предыдущего ответа: для второй страницы это `50`, для третьей — `100`. Подробнее — в статье Особенности списочных методов ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Смещение для постраничной навигации. Метод возвращает не более 50 записей за вызов. Чтобы получить следующую страницу, передайте значение `next` из предыдущего ответа: для второй страницы это `50`, для третьей — `100`. Подробнее — в статье Особенности списочных методов ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/userfieldtype.update": { "post": { "summary": "Изменить настройки типа пользовательских полей userfieldtype.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `userfieldtype.update` изменяет настройки типа пользовательских полей, который ранее зарегистрировало приложение. Метод обновляет адрес обработчика, название, описание и высоту поля, но не меняет код типа.", "operationId": "userfieldtype_update", "tags": [ "Виджеты" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/widgets/user-field/userfieldtype-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Короткий код уже зарегистрированного типа пользовательских полей. Получить код можно методом userfieldtype.list | ||" }, "HANDLER": { "type": "string", "description": "| Новый адрес обработчика пользовательского типа. Битрикс24 загружает этот адрес во фрейме внутри поля | Допустимы абсолютные адреса с протоколом `http` или `https` ||" }, "TITLE": { "type": "string", "description": "| Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей | ||" }, "DESCRIPTION": { "type": "string", "description": "| Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей | ||" }, "OPTIONS": { "type": "object", "description": "| Дополнительные настройки. На данный момент доступен один ключ: `height` — указывает высоту пользовательского поля в пикселях. Значение преобразуется в целое число." }, "LANG_ALL": { "type": "object", "description": "| Название и описание типа для разных языков. Ключ объекта — код языка, значение — объект с полями `TITLE` и `DESCRIPTION` | ||" } }, "required": [ "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| Короткий код уже зарегистрированного типа пользовательских полей. Получить код можно методом userfieldtype.list | ||" }, "HANDLER": { "type": "string", "description": "| Новый адрес обработчика пользовательского типа. Битрикс24 загружает этот адрес во фрейме внутри поля | Допустимы абсолютные адреса с протоколом `http` или `https` ||" }, "TITLE": { "type": "string", "description": "| Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей | ||" }, "DESCRIPTION": { "type": "string", "description": "| Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей | ||" }, "OPTIONS": { "type": "object", "description": "| Дополнительные настройки. На данный момент доступен один ключ: `height` — указывает высоту пользовательского поля в пикселях. Значение преобразуется в целое число." }, "LANG_ALL": { "type": "object", "description": "| Название и описание типа для разных языков. Ключ объекта — код языка, значение — объект с полями `TITLE` и `DESCRIPTION` | ||" } }, "required": [ "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/vote.AttachedVote.download": { "post": { "summary": "Скачать отчет по голосованию vote.AttachedVote.download", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.download` формирует и отдает для скачивания отчет по голосованию в указанном формате.", "operationId": "vote_AttachedVote_download", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.download.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.get": { "post": { "summary": "Получить данные прикрепленного голосования vote.AttachedVote.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.get` возвращает данные прикрепленного голосования.", "operationId": "vote_AttachedVote_get", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, может быть равен `voteId` из результатов vote.Integration.Im.send ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, может быть равен `voteId` из результатов vote.Integration.Im.send ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getAnswerVoted": { "post": { "summary": "Получить список проголосовавших за ответ vote.AttachedVote.getAnswerVoted", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.getAnswerVoted` возвращает список пользователей, проголосовавших за указанный вариант ответа.", "operationId": "vote_AttachedVote_getAnswerVoted", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.getAnswerVoted.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "answerId": { "type": "integer", "description": "| Идентификатор ответа, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "pageNavigation": { "type": "object", "description": "| Параметры постраничной навигации, например { size: 10, page: 1 } ||" }, "userForMobileFormat": { "type": "boolean", "description": "| Формат данных пользователей для мобильных устройств. Значение по умолчанию: `false` ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "answerId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "answerId": { "type": "integer", "description": "| Идентификатор ответа, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "pageNavigation": { "type": "object", "description": "| Параметры постраничной навигации, например { size: 10, page: 1 } ||" }, "userForMobileFormat": { "type": "boolean", "description": "| Формат данных пользователей для мобильных устройств. Значение по умолчанию: `false` ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "answerId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getMany": { "post": { "summary": "Получить несколько голосований vote.AttachedVote.getMany", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.getMany` возвращает данные нескольких голосований по идентификаторам элементов, к которым прикреплено голосование.", "operationId": "vote_AttachedVote_getMany", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.getMany.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Массив идентификаторов элементов, возможные значения:" } }, "required": [ "moduleId", "entityType", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Массив идентификаторов элементов, возможные значения:" } }, "required": [ "moduleId", "entityType", "entityId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getWithVoted": { "post": { "summary": "Получить данные голосования с информацией о проголосовавших vote.AttachedVote.getWithVoted", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.getWithVoted` возвращает данные прикрепленного голосования вместе с информацией о проголосовавших пользователях.", "operationId": "vote_AttachedVote_getWithVoted", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.getWithVoted.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "pageSize": { "type": "integer", "description": "| Количество записей на странице для списка проголосовавших." }, "userForMobileFormat": { "type": "boolean", "description": "| Формат данных пользователей для мобильных устройств." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "pageSize": { "type": "integer", "description": "| Количество записей на странице для списка проголосовавших." }, "userForMobileFormat": { "type": "boolean", "description": "| Формат данных пользователей для мобильных устройств." }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.recall": { "post": { "summary": "Отозвать свой голос vote.AttachedVote.recall", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.recall` отзывает голос пользователя в активном голосовании. Метод работает только с теми голосованиями, в которых активна опция Разрешить переголосование.", "operationId": "vote_AttachedVote_recall", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.recall.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.resume": { "post": { "summary": "Возобновить голосование vote.AttachedVote.resume", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.resume` возобновляет остановленное голосование, позволяя пользователям снова участвовать в нем.", "operationId": "vote_AttachedVote_resume", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.resume.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.stop": { "post": { "summary": "Остановить голосование vote.AttachedVote.stop", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.stop` останавливает активное голосование, запрещая дальнейшее участие в нем.", "operationId": "vote_AttachedVote_stop", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.stop.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.vote": { "post": { "summary": "Проголосовать в прикрепленном голосовании vote.AttachedVote.vote", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.AttachedVote.vote` позволяет проголосовать в прикрепленном голосовании.", "operationId": "vote_AttachedVote_vote", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.attachedvote.vote.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "ballot": { "type": "object", "description": "| Данные голоса в формате:" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" }, "actionUuid": { "type": "string", "description": "| Идентификатор действия на стороне клиента длиной до 1000 символов. Значение возвращается инициатору вызова в Pull-событии об изменении голосования и позволяет сопоставить событие с запросом. По умолчанию — пустая строка ||" } }, "required": [ "attachId", "ballot", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany ||" }, "ballot": { "type": "object", "description": "| Данные голоса в формате:" }, "moduleId": { "type": "string", "description": "| Идентификатор модуля, возможные значения:" }, "entityType": { "type": "string", "description": "| Тип объекта, возможные значения:" }, "entityId": { "type": "integer", "description": "| Идентификатор элемента, возможные значения:" }, "signedAttachId": { "type": "string", "description": "| Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа `signedAttachId` ||" }, "actionUuid": { "type": "string", "description": "| Идентификатор действия на стороне клиента длиной до 1000 символов. Значение возвращается инициатору вызова в Pull-событии об изменении голосования и позволяет сопоставить событие с запросом. По умолчанию — пустая строка ||" } }, "required": [ "attachId", "ballot", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.Integration.Im.send": { "post": { "summary": "Создать и отправить голосование в чат vote.Integration.Im.send", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `vote.Integration.Im.send` создает и отправляет голосование в указанный чат мессенджера.", "operationId": "vote_Integration_Im_send", "tags": [ "Опросы" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/vote/vote.integration.im.send.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "integer", "description": "| Идентификатор чата, в который отправляется голосование. Получить можно методами im.chat.add, im.chat.get, im.recent.get, im.recent.list ||" }, "IM_MESSAGE_VOTE_DATA": { "type": "object", "description": "| Данные голосования с вопросом и вариантами ответов. Структура описана ниже ||" }, "templateId": { "type": "string", "description": "| Уникальный идентификатор запроса, требований к формату нет." }, "QUESTIONS": { "type": "array", "items": {}, "description": "| Массив вопросов голосования, структура описана ниже. Максимум 1 вопрос ||" }, "ANONYMITY": { "type": "integer", "description": "| Анонимность голосования. Возможные значения:" }, "OPTIONS": { "type": "integer", "description": "| Разрешить переголосование. Возможные значения:" }, "QUESTION": { "type": "string", "description": "| Текст вопроса ||" }, "FIELD_TYPE": { "type": "integer", "description": "| Тип поля для ответа. Возможные значения:" }, "ANSWERS": { "type": "array", "items": {}, "description": "| Массив вариантов ответов, структура описана ниже. Минимум 2 варианта, максимум 10 ||" }, "MESSAGE": { "type": "string", "description": "| Текст варианта ответа ||" } }, "required": [ "chatId", "IM_MESSAGE_VOTE_DATA", "QUESTIONS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "chatId": { "type": "integer", "description": "| Идентификатор чата, в который отправляется голосование. Получить можно методами im.chat.add, im.chat.get, im.recent.get, im.recent.list ||" }, "IM_MESSAGE_VOTE_DATA": { "type": "object", "description": "| Данные голосования с вопросом и вариантами ответов. Структура описана ниже ||" }, "templateId": { "type": "string", "description": "| Уникальный идентификатор запроса, требований к формату нет." }, "QUESTIONS": { "type": "array", "items": {}, "description": "| Массив вопросов голосования, структура описана ниже. Максимум 1 вопрос ||" }, "ANONYMITY": { "type": "integer", "description": "| Анонимность голосования. Возможные значения:" }, "OPTIONS": { "type": "integer", "description": "| Разрешить переголосование. Возможные значения:" }, "QUESTION": { "type": "string", "description": "| Текст вопроса ||" }, "FIELD_TYPE": { "type": "integer", "description": "| Тип поля для ответа. Возможные значения:" }, "ANSWERS": { "type": "array", "items": {}, "description": "| Массив вариантов ответов, структура описана ниже. Минимум 2 варианта, максимум 10 ||" }, "MESSAGE": { "type": "string", "description": "| Текст варианта ответа ||" } }, "required": [ "chatId", "IM_MESSAGE_VOTE_DATA", "QUESTIONS" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/voximplant.callback.start": { "post": { "summary": "Запустить обратный звонок voximplant.callback.start", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.callback.start` запускает обратный звонок между сотрудником и клиентом.", "operationId": "voximplant_callback_start", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-callback-start.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается обратный звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер клиента, на который нужно позвонить ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| Текст, который система произнесет сотруднику перед соединением с клиентом ||" }, "VOICE": { "type": "string", "description": "| Идентификатор голоса для синтеза речи." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается обратный звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер клиента, на который нужно позвонить ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| Текст, который система произнесет сотруднику перед соединением с клиентом ||" }, "VOICE": { "type": "string", "description": "| Идентификатор голоса для синтеза речи." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.infocall.startwithsound": { "post": { "summary": "Осуществить автозвонок с проигрыванием MP3-файла voximplant.infocall.startwithsound", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.infocall.startwithsound` запускает автозвонок и воспроизводит MP3-файл по URL.", "operationId": "voximplant_infocall_startwithsound", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-infocall-start-with-sound.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер, на который нужно выполнить звонок ||" }, "URL": { "type": "string", "description": "| Ссылка на MP3-файл, который нужно проиграть во время звонка ||" } }, "required": [ "FROM_LINE", "TO_NUMBER", "URL" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер, на который нужно выполнить звонок ||" }, "URL": { "type": "string", "description": "| Ссылка на MP3-файл, который нужно проиграть во время звонка ||" } }, "required": [ "FROM_LINE", "TO_NUMBER", "URL" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.infocall.startwithtext": { "post": { "summary": "Осуществить автозвонок голосовым роботом voximplant.infocall.startwithtext", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.infocall.startwithtext` запускает автозвонок и воспроизводит получателю заданный текст с помощью синтеза речи.", "operationId": "voximplant_infocall_startwithtext", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-infocall-start-with-text.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер, на который нужно выполнить звонок ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| Текст, который будет озвучен получателю ||" }, "VOICE": { "type": "string", "description": "| Идентификатор голоса для синтеза речи." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Идентификатор исходящей линии, с которой запускается звонок." }, "TO_NUMBER": { "type": "string", "description": "| Номер, на который нужно выполнить звонок ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| Текст, который будет озвучен получателю ||" }, "VOICE": { "type": "string", "description": "| Идентификатор голоса для синтеза речи." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.get": { "post": { "summary": "Получить список исходящих линий voximplant.line.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.line.get` возвращает список доступных исходящих линий.", "operationId": "voximplant_line_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/lines/voximplant-line-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.get": { "post": { "summary": "Получить линию для исходящих звонков voximplant.line.outgoing.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.line.outgoing.get` возвращает идентификатор текущей исходящей линии по умолчанию.", "operationId": "voximplant_line_outgoing_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.set": { "post": { "summary": "Установить исходящую линию voximplant.line.outgoing.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.line.outgoing.set` устанавливает исходящую линию по умолчанию.", "operationId": "voximplant_line_outgoing_set", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LINE_ID": { "type": "string", "description": "| Идентификатор линии." } }, "required": [ "LINE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LINE_ID": { "type": "string", "description": "| Идентификатор линии." } }, "required": [ "LINE_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.sip.set": { "post": { "summary": "Установить исходящую SIP-линию voximplant.line.outgoing.sip.set", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.line.outgoing.sip.set` устанавливает SIP-линию в качестве исходящей линии по умолчанию.", "operationId": "voximplant_line_outgoing_sip_set", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-sip-set.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.add": { "post": { "summary": "Создать SIP-линию voximplant.sip.add", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.add` создает новую SIP-линию с привязкой к приложению.", "operationId": "voximplant_sip_add", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-add.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SERVER": { "type": "string", "description": "| Адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Пароль для подключения к серверу. Максимальная длина — 100 символов." }, "TYPE": { "type": "string", "description": "| Тип АТС." }, "TITLE": { "type": "string", "description": "| Название подключения." } }, "required": [ "SERVER", "LOGIN" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SERVER": { "type": "string", "description": "| Адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Пароль для подключения к серверу. Максимальная длина — 100 символов." }, "TYPE": { "type": "string", "description": "| Тип АТС." }, "TITLE": { "type": "string", "description": "| Название подключения." } }, "required": [ "SERVER", "LOGIN" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.connector.status": { "post": { "summary": "Получить статус SIP-коннектора voximplant.sip.connector.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.connector.status` возвращает текущий статус SIP-коннектора.", "operationId": "voximplant_sip_connector_status", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-connector-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.delete": { "post": { "summary": "Удалить SIP-линию voximplant.sip.delete", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.delete` удаляет существующую SIP-линию, созданную текущим приложением.", "operationId": "voximplant_sip_delete", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-delete.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.get": { "post": { "summary": "Получить SIP-линии приложения voximplant.sip.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.get` возвращает список SIP-линий, созданных текущим приложением.", "operationId": "voximplant_sip_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Поле сортировки." }, "ORDER": { "type": "string", "description": "| Направление сортировки." }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Внутренний идентификатор записи SIP-линии." }, "TYPE": { "type": "string", "description": "| Тип АТС." }, "TITLE": { "type": "string", "description": "| Название подключения ||" }, "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии ||" }, "REG_ID": { "type": "integer", "description": "| Идентификатор SIP-регистрации." }, "APP_ID": { "type": "string", "description": "| Идентификатор приложения." }, "SERVER": { "type": "string", "description": "| Адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Пароль для подключения к серверу ||" }, "INCOMING_SERVER": { "type": "string", "description": "| Адрес сервера для входящих звонков." }, "INCOMING_LOGIN": { "type": "string", "description": "| Логин для входящих звонков." }, "INCOMING_PASSWORD": { "type": "string", "description": "| Пароль для входящих звонков." }, "AUTH_USER": { "type": "string", "description": "| Имя пользователя для авторизации ||" }, "OUTBOUND_PROXY": { "type": "string", "description": "| Адрес SIP-прокси для исходящего подключения к оператору или АТС ||" }, "DETECT_LINE_NUMBER": { "type": "string", "description": "| Признак определения номера линии." }, "LINE_DETECT_HEADER_ORDER": { "type": "string", "description": "| Порядок заголовков для определения номера линии ||" }, "REGISTRATION_STATUS_CODE": { "type": "integer", "description": "| Код статуса SIP-регистрации ||" }, "REGISTRATION_ERROR_MESSAGE": { "type": "string", "description": "| Текст ошибки SIP-регистрации ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Поле сортировки." }, "ORDER": { "type": "string", "description": "| Направление сортировки." }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Внутренний идентификатор записи SIP-линии." }, "TYPE": { "type": "string", "description": "| Тип АТС." }, "TITLE": { "type": "string", "description": "| Название подключения ||" }, "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии ||" }, "REG_ID": { "type": "integer", "description": "| Идентификатор SIP-регистрации." }, "APP_ID": { "type": "string", "description": "| Идентификатор приложения." }, "SERVER": { "type": "string", "description": "| Адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Пароль для подключения к серверу ||" }, "INCOMING_SERVER": { "type": "string", "description": "| Адрес сервера для входящих звонков." }, "INCOMING_LOGIN": { "type": "string", "description": "| Логин для входящих звонков." }, "INCOMING_PASSWORD": { "type": "string", "description": "| Пароль для входящих звонков." }, "AUTH_USER": { "type": "string", "description": "| Имя пользователя для авторизации ||" }, "OUTBOUND_PROXY": { "type": "string", "description": "| Адрес SIP-прокси для исходящего подключения к оператору или АТС ||" }, "DETECT_LINE_NUMBER": { "type": "string", "description": "| Признак определения номера линии." }, "LINE_DETECT_HEADER_ORDER": { "type": "string", "description": "| Порядок заголовков для определения номера линии ||" }, "REGISTRATION_STATUS_CODE": { "type": "integer", "description": "| Код статуса SIP-регистрации ||" }, "REGISTRATION_ERROR_MESSAGE": { "type": "string", "description": "| Текст ошибки SIP-регистрации ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.status": { "post": { "summary": "Получить статус SIP-регистрации voximplant.sip.status", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.status` возвращает текущий статус SIP-регистрации для облачной АТС. У офисной АТС нет `REG_ID`, поэтому для нее метод не используется.", "operationId": "voximplant_sip_status", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-status.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REG_ID": { "type": "integer", "description": "| Идентификатор SIP-регистрации." } }, "required": [ "REG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REG_ID": { "type": "integer", "description": "| Идентификатор SIP-регистрации." } }, "required": [ "REG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.update": { "post": { "summary": "Обновить SIP-линию voximplant.sip.update", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.sip.update` обновляет существующую SIP-линию, созданную текущим приложением.", "operationId": "voximplant_sip_update", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/sip/voximplant-sip-update.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." }, "TITLE": { "type": "string", "description": "| Новое название подключения ||" }, "SERVER": { "type": "string", "description": "| Новый адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Новый логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Новый пароль для подключения к серверу. Максимальная длина — 100 символов ||" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Идентификатор настройки SIP-линии." }, "TITLE": { "type": "string", "description": "| Новое название подключения ||" }, "SERVER": { "type": "string", "description": "| Новый адрес сервера SIP-регистрации ||" }, "LOGIN": { "type": "string", "description": "| Новый логин для подключения к серверу ||" }, "PASSWORD": { "type": "string", "description": "| Новый пароль для подключения к серверу. Максимальная длина — 100 символов ||" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.statistic.get": { "post": { "summary": "Получить список истории звонков voximplant.statistic.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.statistic.get` возвращает список звонков из статистики телефонии.", "operationId": "voximplant_statistic_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-statistic-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Поле сортировки." }, "ORDER": { "type": "string", "description": "| Направление сортировки." }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Внутренний идентификатор записи статистики ||" }, "CALL_ID": { "type": "string", "description": "| Идентификатор звонка ||" }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Идентификатор звонка на стороне внешней АТС/интеграции ||" }, "CALL_CATEGORY": { "type": "string", "description": "| Категория звонка ||" }, "PORTAL_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "PORTAL_NUMBER": { "type": "string", "description": "| Номер линии, через который шел звонок ||" }, "PHONE_NUMBER": { "type": "string", "description": "| Номер абонента ||" }, "CALL_TYPE": { "type": "integer", "description": "| Тип звонка." }, "CALL_DURATION": { "type": "integer", "description": "| Длительность звонка в секундах ||" }, "CALL_START_DATE": { "type": "string", "format": "date-time", "description": "| Дата и время начала звонка в формате ISO-8601 с указанием часового пояса ||" }, "CALL_LOG": { "type": "string", "description": "| URL лога звонка ||" }, "CALL_RECORD_URL": { "type": "string", "description": "| URL записи звонка ||" }, "CALL_VOTE": { "type": "integer", "description": "| Оценка звонка." }, "COST": { "type": "number", "format": "double", "description": "| Стоимость звонка ||" }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости звонка ||" }, "CALL_FAILED_CODE": { "type": "string", "description": "| Код результата звонка." }, "CALL_FAILED_REASON": { "type": "string", "description": "| Текст причины/результата звонка ||" }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта CRM из `CRM_ENTITY_TYPE` ||" }, "CRM_ACTIVITY_ID": { "type": "integer", "description": "| Идентификатор CRM-дела звонка ||" }, "REST_APP_ID": { "type": "integer", "description": "| Идентификатор приложения ||" }, "REST_APP_NAME": { "type": "string", "description": "| Название приложения ||" }, "TRANSCRIPT_ID": { "type": "integer", "description": "| Идентификатор расшифровки звонка ||" }, "TRANSCRIPT_PENDING": { "type": "string", "description": "| Признак ожидания расшифровки." }, "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии на стороне телефонии ||" }, "REDIAL_ATTEMPT": { "type": "integer", "description": "| Номер попытки дозвона (для callback-сценариев) ||" }, "COMMENT": { "type": "string", "description": "| Комментарий к звонку ||" }, "RECORD_DURATION": { "type": "integer", "description": "| Длительность файла записи звонка ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Объект для фильтрации в формате `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Поле сортировки." }, "ORDER": { "type": "string", "description": "| Направление сортировки." }, "start": { "type": "integer", "description": "| Параметр постраничной навигации." }, "ID": { "type": "integer", "description": "| Внутренний идентификатор записи статистики ||" }, "CALL_ID": { "type": "string", "description": "| Идентификатор звонка ||" }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Идентификатор звонка на стороне внешней АТС/интеграции ||" }, "CALL_CATEGORY": { "type": "string", "description": "| Категория звонка ||" }, "PORTAL_USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." }, "PORTAL_NUMBER": { "type": "string", "description": "| Номер линии, через который шел звонок ||" }, "PHONE_NUMBER": { "type": "string", "description": "| Номер абонента ||" }, "CALL_TYPE": { "type": "integer", "description": "| Тип звонка." }, "CALL_DURATION": { "type": "integer", "description": "| Длительность звонка в секундах ||" }, "CALL_START_DATE": { "type": "string", "format": "date-time", "description": "| Дата и время начала звонка в формате ISO-8601 с указанием часового пояса ||" }, "CALL_LOG": { "type": "string", "description": "| URL лога звонка ||" }, "CALL_RECORD_URL": { "type": "string", "description": "| URL записи звонка ||" }, "CALL_VOTE": { "type": "integer", "description": "| Оценка звонка." }, "COST": { "type": "number", "format": "double", "description": "| Стоимость звонка ||" }, "COST_CURRENCY": { "type": "string", "description": "| Валюта стоимости звонка ||" }, "CALL_FAILED_CODE": { "type": "string", "description": "| Код результата звонка." }, "CALL_FAILED_REASON": { "type": "string", "description": "| Текст причины/результата звонка ||" }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Тип объекта CRM." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Идентификатор объекта CRM из `CRM_ENTITY_TYPE` ||" }, "CRM_ACTIVITY_ID": { "type": "integer", "description": "| Идентификатор CRM-дела звонка ||" }, "REST_APP_ID": { "type": "integer", "description": "| Идентификатор приложения ||" }, "REST_APP_NAME": { "type": "string", "description": "| Название приложения ||" }, "TRANSCRIPT_ID": { "type": "integer", "description": "| Идентификатор расшифровки звонка ||" }, "TRANSCRIPT_PENDING": { "type": "string", "description": "| Признак ожидания расшифровки." }, "SESSION_ID": { "type": "integer", "description": "| Идентификатор сессии на стороне телефонии ||" }, "REDIAL_ATTEMPT": { "type": "integer", "description": "| Номер попытки дозвона (для callback-сценариев) ||" }, "COMMENT": { "type": "string", "description": "| Комментарий к звонку ||" }, "RECORD_DURATION": { "type": "integer", "description": "| Длительность файла записи звонка ||" } } } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.tts.voices.get": { "post": { "summary": "Получить список доступных голосов для синтеза речи voximplant.tts.voices.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.tts.voices.get` возвращает список доступных голосов для синтеза речи.", "operationId": "voximplant_tts_voices_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-tts-voices-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.url.get": { "post": { "summary": "Получить ссылки для навигации по страницам телефонии voximplant.url.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.url.get` возвращает ссылки для навигации по страницам телефонии.", "operationId": "voximplant_url_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/voximplant-url-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.user.activatePhone": { "post": { "summary": "Активировать SIP-аппарат пользователя voximplant.user.activatePhone", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.user.activatePhone` устанавливает сотруднику признак наличия SIP-аппарата.", "operationId": "voximplant_user_activatePhone", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/users/voximplant-user-activate-phone.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } }, "required": [ "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя." } }, "required": [ "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.user.deactivatePhone": { "post": { "summary": "Деактивировать SIP-аппарат пользователя voximplant.user.deactivatePhone", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Не публиковать страницу до исправления и повторной проверки метода. На тестовом Битрикс24 метод активирует SIP-аппарат вместо деактивации.", "operationId": "voximplant_user_deactivatePhone", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, у которого нужно деактивировать SIP-аппарат." } }, "required": [ "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Идентификатор пользователя, у которого нужно деактивировать SIP-аппарат." } }, "required": [ "USER_ID" ] } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.user.get": { "post": { "summary": "Получить настройки пользователей voximplant.user.get", "description": "Выберите инструмент для разработки с AI-агентом: - используйте [Битрикс24 Вайбкод](../../../../ai-tools/vibecode.md), чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга - используйте [MCP-сервер](../../../../ai-tools/mcp.md), чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации Метод `voximplant.user.get` возвращает настройки пользователей.", "operationId": "voximplant_user_get", "tags": [ "Телефония" ], "externalDocs": { "url": "https://apidocs.bitrix24.ru/api-reference/telephony/voximplant/users/voximplant-user-get.html", "description": "Официальная документация" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Ошибка запроса (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } } }, "components": { "securitySchemes": { "AccessToken": { "type": "apiKey", "in": "query", "name": "auth", "description": "OAuth 2.0 access_token или токен входящего вебхука" }, "OAuth2": { "type": "oauth2", "description": "OAuth 2.0 авторизация", "flows": { "authorizationCode": { "authorizationUrl": "https://oauth.bitrix.info/oauth/authorize/", "tokenUrl": "https://oauth.bitrix.info/oauth/token/", "scopes": { "crm": "CRM — лиды, сделки, контакты, компании, смарт-процессы", "task": "Задачи и проекты", "disk": "Диск — файлы и папки", "im": "Чаты и уведомления", "imbot": "Чат-боты", "imopenlines": "Открытые линии — коннекторы мессенджеров", "telephony": "Телефония", "sale": "Интернет-магазин — заказы, доставки", "catalog": "Торговый каталог — товары, цены", "calendar": "Календарь", "bizproc": "Бизнес-процессы и роботы", "user": "Пользователи", "department": "Структура компании", "timeman": "Учёт рабочего времени", "landing": "Сайты и лендинги", "pay_system": "Платёжные системы", "cashbox": "Онлайн-кассы", "delivery": "Службы доставки", "documentgenerator": "Генератор документов", "lists": "Универсальные списки", "entity": "Хранилище данных", "log": "Лента новостей", "sonet_group": "Рабочие группы и проекты", "mailservice": "Почтовые сервисы", "messageservice": "Провайдеры сообщений (СМС)", "biconnector": "BIconnector — BI-аналитика", "ai_admin": "CoPilot / AI", "sign.b2e": "Подпись — КЭДО", "vote": "Опросы и голосования", "booking": "Онлайн-запись", "userconsent": "Пользовательские соглашения", "userfieldconfig": "Настройки пользовательских полей" } } } } }, "schemas": { "BitrixResponse": { "type": "object", "description": "Стандартный ответ REST API Битрикс24", "properties": { "result": { "description": "Результат выполнения метода" }, "total": { "type": "integer", "description": "Общее количество записей (для списочных методов)" }, "next": { "type": "integer", "description": "Следующий offset для пагинации" }, "time": { "$ref": "#/components/schemas/BitrixTime" } } }, "BitrixError": { "type": "object", "description": "Ответ об ошибке REST API Битрикс24", "required": [ "error", "error_description" ], "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "ACCESS_DENIED" }, "error_description": { "type": "string", "description": "Текстовое описание ошибки", "example": "Access denied." } } }, "BitrixTime": { "type": "object", "description": "Информация о времени выполнения запроса", "properties": { "start": { "type": "number", "format": "double" }, "finish": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "processing": { "type": "number", "format": "double" }, "date_start": { "type": "string", "format": "date-time" }, "date_finish": { "type": "string", "format": "date-time" }, "operating_reset_at": { "type": "integer" }, "operating": { "type": "number", "format": "double" } } } } } }